Skip to content

Commit 5a3bf90

Browse files
committed
Rust: Add qldoc comments
1 parent a96a5fc commit 5a3bf90

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

rust/ql/lib/codeql/rust/dataflow/internal/Content.qll

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,10 @@ class TupleFieldContent extends FieldContent, TTupleFieldContent {
3030

3131
TupleFieldContent() { this = TTupleFieldContent(field) }
3232

33+
/** Holds if this field belongs to an enum variant. */
3334
predicate isVariantField(Variant v, int pos) { field.isVariantField(v, pos) }
3435

36+
/** Holds if this field belongs to a struct. */
3537
predicate isStructField(Struct s, int pos) { field.isStructField(s, pos) }
3638

3739
override FieldExprCfgNode getAnAccess() { field = result.getFieldExpr().getTupleField() }
@@ -61,8 +63,10 @@ class RecordFieldContent extends FieldContent, TRecordFieldContent {
6163

6264
RecordFieldContent() { this = TRecordFieldContent(field) }
6365

66+
/** Holds if this field belongs to an enum variant. */
6467
predicate isVariantField(Variant v, string name) { field.isVariantField(v, name) }
6568

69+
/** Holds if this field belongs to a struct. */
6670
predicate isStructField(Struct s, string name) { field.isStructField(s, name) }
6771

6872
override FieldExprCfgNode getAnAccess() { field = result.getFieldExpr().getRecordField() }
@@ -141,6 +145,7 @@ final class TuplePositionContent extends FieldContent, TTuplePositionContent {
141145

142146
TuplePositionContent() { this = TTuplePositionContent(pos) }
143147

148+
/** Gets the index of this tuple position. */
144149
int getPosition() { result = pos }
145150

146151
override FieldExprCfgNode getAnAccess() {

0 commit comments

Comments
 (0)