Skip to content

Commit 2ecd45a

Browse files
committed
Simplify redundant wording in doc
1 parent bbb7548 commit 2ecd45a

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

src/main/engine/Input.hpp

+14-14
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ namespace nta
6161
* Constructor.
6262
*
6363
* @param region
64-
* The region that this Input object belongs to.
64+
* The region that the input belongs to.
6565
* @param type
6666
* The type of the input, TODO
6767
* @param isRegionLevel
68-
* Whether the Input object is region level, i.e. TODO
68+
* Whether the input is region level, i.e. TODO
6969
*/
7070
Input(Region& region, NTA_BasicType type, bool isRegionLevel);
7171

@@ -78,21 +78,21 @@ namespace nta
7878

7979
/**
8080
*
81-
* Set the name for the Input object.
81+
* Set the name for the input.
8282
*
8383
* Inputs need to know their own name for error messages.
8484
*
8585
* @param name
86-
* The name of the Input object
86+
* The name of the input
8787
*
8888
*/
8989
void setName(const std::string& name);
9090

9191
/**
92-
* Get the name of the Input object.
92+
* Get the name of the input.
9393
*
9494
* @return
95-
* The name of the Input object
95+
* The name of the input
9696
*/
9797
const std::string& getName() const;
9898

@@ -114,7 +114,7 @@ namespace nta
114114
Output* srcOutput);
115115

116116
/**
117-
* Locate an existing Link to the Input object.
117+
* Locate an existing Link to the input.
118118
*
119119
* It's called by Network.removeLink() and internally when adding a link
120120
*
@@ -129,7 +129,7 @@ namespace nta
129129
const std::string& srcOutputName);
130130

131131
/**
132-
* Removing an existing link from the Input object.
132+
* Removing an existing link from the input.
133133
*
134134
* It's called in four cases:
135135
*
@@ -171,30 +171,30 @@ namespace nta
171171

172172
/**
173173
*
174-
* Get the Region that this Input object belongs to.
174+
* Get the Region that the input belongs to.
175175
*
176176
* @returns
177-
* The mutable reference to the Region that this Input object belongs to
177+
* The mutable reference to the Region that the input belongs to
178178
*/
179179
Region&
180180
getRegion();
181181

182182
/**
183183
*
184-
* Get all the Link objects added to this Input object.
184+
* Get all the Link objects added to the input.
185185
*
186186
* @returns
187-
* All the Link objects added to this Input object
187+
* All the Link objects added to the input
188188
*/
189189
const std::vector<Link*>&
190190
getLinks();
191191

192192
/**
193193
*
194-
* Tells whether the Input object is region level, i.e. TODO
194+
* Tells whether the input is region level, i.e. TODO
195195
*
196196
* @returns
197-
* Whether the Input object is region level, i.e. TODO
197+
* Whether the input is region level, i.e. TODO
198198
*/
199199
bool
200200
isRegionLevel();

src/main/engine/Output.hpp

+14-14
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ namespace nta
4848
* Constructor.
4949
*
5050
* @param region
51-
* The region that this Output object belongs to.
51+
* The region that the output belongs to.
5252
* @param type
5353
* The type of the output, TODO
5454
* @param isRegionLevel
55-
* Whether the Output object is region level, i.e. TODO
55+
* Whether the output is region level, i.e. TODO
5656
*/
5757
Output(Region& region, NTA_BasicType type, bool isRegionLevel);
5858

@@ -62,20 +62,20 @@ namespace nta
6262
~Output();
6363

6464
/**
65-
* Set the name for the Output object.
65+
* Set the name for the output.
6666
*
6767
* Output need to know their own name for error messages.
6868
*
6969
* @param name
70-
* The name of the Output object
70+
* The name of the output
7171
*/
7272
void setName(const std::string& name);
7373

7474
/**
75-
* Get the name of the Output object.
75+
* Get the name of the output.
7676
*
7777
* @return
78-
* The name of the Output object
78+
* The name of the output
7979
*/
8080
const std::string& getName() const;
8181

@@ -107,7 +107,7 @@ namespace nta
107107
addLink(Link* link);
108108

109109
/**
110-
* Removing an existing link from the Output object.
110+
* Removing an existing link from the output.
111111
*
112112
* @note Called only by Input.removeLink() even if triggered by
113113
* Network.removeRegion() while removing the region that contains us.
@@ -119,19 +119,19 @@ namespace nta
119119
removeLink(Link*);
120120

121121
/**
122-
* Tells whether the Output object has outgoing links, i.e. TODO
122+
* Tells whether the output has outgoing links, i.e. TODO
123123
*
124124
* @note We cannot delete a region if there are any outgoing links
125125
* This allows us to check in Network.removeRegion() and Network.~Network().
126126
* @returns
127-
* Whether the Output object has outgoing links
127+
* Whether the output has outgoing links
128128
*/
129129
bool
130130
hasOutgoingLinks();
131131

132132
/**
133133
*
134-
* Get the data of the Output object.
134+
* Get the data of the output.
135135
*
136136
* @returns
137137
* A constant reference to the data of the output as an @c Array
@@ -144,20 +144,20 @@ namespace nta
144144

145145
/**
146146
*
147-
* Tells whether the Output object is region level, i.e. TODO
147+
* Tells whether the output is region level, i.e. TODO
148148
*
149149
* @returns
150-
* Whether the Output object is region level, i.e. TODO
150+
* Whether the output is region level, i.e. TODO
151151
*/
152152
bool
153153
isRegionLevel() const;
154154

155155
/**
156156
*
157-
* Get the Region that this Output object belongs to.
157+
* Get the Region that the output belongs to.
158158
*
159159
* @returns
160-
* The mutable reference to the Region that this Output object belongs to
160+
* The mutable reference to the Region that the output belongs to
161161
*/
162162
Region&
163163
getRegion() const;

0 commit comments

Comments
 (0)