hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-25 08:45:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update QLDoc in FlowBarrier.qll

Browse Source
This commit is contained in:
Owen Mansel-Chan
2026-03-23 16:22:27 +00:00
parent d82fc67b36
commit 97ebc0e839
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
rust/ql/lib/codeql/rust/dataflow/FlowBarrier.qll
View File

@@ -1,7 +1,7 @@
/**
* Provides classes and predicates for defining barriers.
* Provides classes and predicates for defining barriers and barrier guards.
*
* Flow barriers defined here feed into data flow configurations as follows:
* Flow barriers and barrier guards defined here feed into data flow configurations as follows:
*
* ```text
* data from *.model.yml | QL extensions of FlowBarrier::Range
@@ -11,10 +11,18 @@
* barrierNode predicate | other QL defined barriers, for example using concepts
* v v
* various Barrier classes for specific data flow configurations
*
* data from *.model.yml | QL extensions of FlowBarrierGuard::Range
* v v
* FlowBarrierGuard (associated with a models-as-data kind string)
* v
* barrierNode predicate | other QL defined barrier guards, for example using concepts
* v v
* various Barrier classes for specific data flow configurations
* ```
*
* New barriers should be defined using models-as-data, QL extensions of
* `FlowBarrier::Range`, or concepts. Data flow configurations should use the
* New barriers and barrier guards should be defined using models-as-data, QL extensions of
* `FlowBarrier::Range`/`FlowBarrierGuard::Range`, or concepts. Data flow configurations should use the
* `barrierNode` predicate and/or concepts to define their barriers.
*/