Skip to content

Commit e2a0849

Browse files
committed
Java: Add more qldoc.
1 parent 37455ec commit e2a0849

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

shared/dataflow/codeql/dataflow/VariableCapture.qll

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,23 +169,33 @@ signature module OutputSig<InputSig I> {
169169
I::Callable getEnclosingCallable();
170170
}
171171

172+
/** A data flow node for an expression. */
172173
class ExprNode extends ClosureNode {
174+
/** Gets the expression corresponding to this node. */
173175
I::Expr getExpr();
174176
}
175177

178+
/** A data flow node for the `PostUpdateNode` of an expression. */
176179
class ExprPostUpdateNode extends ClosureNode {
180+
/** Gets the expression corresponding to this node. */
177181
I::Expr getExpr();
178182
}
179183

184+
/** A data flow node for a parameter. */
180185
class ParameterNode extends ClosureNode {
186+
/** Gets the parameter corresponding to this node. */
181187
I::CapturedParameter getParameter();
182188
}
183189

190+
/** A data flow node for an instance parameter. */
184191
class ThisParameterNode extends ClosureNode {
192+
/** Gets the callable this instance parameter belongs to. */
185193
I::Callable getCallable();
186194
}
187195

196+
/** A data flow node for the instance parameter argument of a constructor call. */
188197
class MallocNode extends ClosureNode {
198+
/** Gets closure construction that is the post-update of this node. */
189199
I::ClosureExpr getClosureExpr();
190200
}
191201

@@ -195,10 +205,13 @@ signature module OutputSig<InputSig I> {
195205
/** Holds if there is a local flow step from `node1` to `node2`. */
196206
predicate localFlowStep(ClosureNode node1, ClosureNode node2);
197207

208+
/** Holds if there is a store step from `node1` to `node2`. */
198209
predicate storeStep(ClosureNode node1, I::CapturedVariable v, ClosureNode node2);
199210

211+
/** Holds if there is a read step from `node1` to `node2`. */
200212
predicate readStep(ClosureNode node1, I::CapturedVariable v, ClosureNode node2);
201213

214+
/** Holds if this-to-this summaries are expected for `c`. */
202215
predicate heuristicAllowInstanceParameterReturnInSelf(I::Callable c);
203216
}
204217

0 commit comments

Comments
 (0)