Skip to content

Commit 97ebc0e

Browse files
committed
Update QLDoc in FlowBarrier.qll
1 parent d82fc67 commit 97ebc0e

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

rust/ql/lib/codeql/rust/dataflow/FlowBarrier.qll

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
2-
* Provides classes and predicates for defining barriers.
2+
* Provides classes and predicates for defining barriers and barrier guards.
33
*
4-
* Flow barriers defined here feed into data flow configurations as follows:
4+
* Flow barriers and barrier guards defined here feed into data flow configurations as follows:
55
*
66
* ```text
77
* data from *.model.yml | QL extensions of FlowBarrier::Range
@@ -11,10 +11,18 @@
1111
* barrierNode predicate | other QL defined barriers, for example using concepts
1212
* v v
1313
* various Barrier classes for specific data flow configurations
14+
*
15+
* data from *.model.yml | QL extensions of FlowBarrierGuard::Range
16+
* v v
17+
* FlowBarrierGuard (associated with a models-as-data kind string)
18+
* v
19+
* barrierNode predicate | other QL defined barrier guards, for example using concepts
20+
* v v
21+
* various Barrier classes for specific data flow configurations
1422
* ```
1523
*
16-
* New barriers should be defined using models-as-data, QL extensions of
17-
* `FlowBarrier::Range`, or concepts. Data flow configurations should use the
24+
* New barriers and barrier guards should be defined using models-as-data, QL extensions of
25+
* `FlowBarrier::Range`/`FlowBarrierGuard::Range`, or concepts. Data flow configurations should use the
1826
* `barrierNode` predicate and/or concepts to define their barriers.
1927
*/
2028

0 commit comments

Comments
 (0)