Skip to content

Commit daf7d1b

Browse files
committed
C++: Add more QLDoc.
1 parent 7583fe2 commit daf7d1b

File tree

1 file changed

+24
-0
lines changed
  • cpp/ql/lib/semmle/code/cpp/models/implementations

1 file changed

+24
-0
lines changed

cpp/ql/lib/semmle/code/cpp/models/implementations/Iterator.qll

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,9 @@ private FunctionInput getIteratorArgumentInput(Operator op, int index) {
109109

110110
/**
111111
* A non-member `operator++` or `operator--` function for an iterator type.
112+
*
113+
* Note that this class _only_ matches non-member functions. To find both
114+
* non-member and versions, use `IteratorCrementOperator`.
112115
*/
113116
class IteratorCrementNonMemberOperator extends Operator {
114117
IteratorCrementNonMemberOperator() {
@@ -129,6 +132,9 @@ private class IteratorCrementNonMemberOperatorModel extends IteratorCrementNonMe
129132

130133
/**
131134
* An `operator++` or `operator--` member function for an iterator type.
135+
*
136+
* Note that this class _only_ matches member functions. To find both
137+
* non-member and member versions, use `IteratorCrementOperator`.
132138
*/
133139
class IteratorCrementMemberOperator extends MemberFunction {
134140
IteratorCrementMemberOperator() {
@@ -167,6 +173,9 @@ class IteratorCrementOperator extends Function {
167173

168174
/**
169175
* A non-member `operator+` function for an iterator type.
176+
*
177+
* Note that this class _only_ matches non-member functions. To find both
178+
* non-member and member versions, use `IteratorBinaryAddOperator`.
170179
*/
171180
class IteratorAddNonMemberOperator extends Operator {
172181
IteratorAddNonMemberOperator() {
@@ -184,6 +193,9 @@ private class IteratorAddNonMemberOperatorModel extends IteratorAddNonMemberOper
184193

185194
/**
186195
* An `operator+` or `operator-` member function of an iterator class.
196+
*
197+
* Note that this class _only_ matches member functions. To find both
198+
* non-member and member versions, use `IteratorBinaryAddOperator`.
187199
*/
188200
class IteratorBinaryArithmeticMemberOperator extends MemberFunction {
189201
IteratorBinaryArithmeticMemberOperator() {
@@ -229,6 +241,9 @@ private class IteratorSubOperatorModel extends IteratorSubNonMemberOperator, Tai
229241

230242
/**
231243
* A non-member `operator+=` or `operator-=` function for an iterator type.
244+
*
245+
* Note that this class _only_ matches non-member functions. To find both
246+
* non-member and member versions, use `IteratorAssignArithmeticOperator`.
232247
*/
233248
class IteratorAssignArithmeticNonMemberOperator extends Operator {
234249
IteratorAssignArithmeticNonMemberOperator() {
@@ -258,6 +273,9 @@ private class IteratorAssignArithmeticNonMemberOperatorModel extends IteratorAss
258273

259274
/**
260275
* An `operator+=` or `operator-=` member function of an iterator class.
276+
*
277+
* Note that this class _only_ matches member functions. To find both
278+
* non-member and member versions, use `IteratorAssignArithmeticOperator`.
261279
*/
262280
class IteratorAssignArithmeticMemberOperator extends MemberFunction {
263281
IteratorAssignArithmeticMemberOperator() {
@@ -297,6 +315,9 @@ class IteratorAssignArithmeticOperator extends Function {
297315

298316
/**
299317
* A prefix `operator*` member function for an iterator type.
318+
*
319+
* Note that this class _only_ matches member functions. To find both
320+
* non-member and member versions, use `IteratorPointerDereferenceOperator`.
300321
*/
301322
class IteratorPointerDereferenceMemberOperator extends MemberFunction, TaintFunction,
302323
IteratorReferenceFunction {
@@ -315,6 +336,9 @@ class IteratorPointerDereferenceMemberOperator extends MemberFunction, TaintFunc
315336

316337
/**
317338
* A non-member prefix `operator*` function for an iterator type.
339+
*
340+
* Note that this class _only_ matches non-member functions. To find both
341+
* non-member and member versions, use `IteratorPointerDereferenceOperator`.
318342
*/
319343
class IteratorPointerDereferenceNonMemberOperator extends Operator, IteratorReferenceFunction {
320344
IteratorPointerDereferenceNonMemberOperator() {

0 commit comments

Comments
 (0)