Skip to content

Commit f4a05c1

Browse files
committed
Shared: Add some qldoc.
1 parent 15daa51 commit f4a05c1

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

shared/dataflow/codeql/dataflow/VariableCapture.qll

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* Provides a module for synthesizing data-flow nodes and related step relations
3+
* for supporting flow through captured variables.
4+
*/
5+
16
private import codeql.util.Boolean
27
private import codeql.util.Unit
38
private import codeql.ssa.Ssa as Ssa
@@ -159,6 +164,10 @@ signature module OutputSig<InputSig I> {
159164
predicate parameterReadStep(ClosureNode node, I::CapturedParameter p);
160165
}
161166

167+
/**
168+
* Constructs the type `ClosureNode` and associated step relations, which are
169+
* intended to be included in the data-flow node and step relations.
170+
*/
162171
module Flow<InputSig Input> implements OutputSig<Input> {
163172
private import Input
164173

0 commit comments

Comments
 (0)