Skip to content

Commit 1fece75

Browse files
geoffw0aschackmull
andauthored
Apply suggestions from code review
Co-authored-by: Anders Schack-Mulligen <[email protected]>
1 parent a499919 commit 1fece75

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

shared/dataflow/codeql/dataflow/DataFlow.qll

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,20 @@ signature module InputSig {
3434
}
3535

3636
/**
37-
* A node in the data flow graph that represents an output.
37+
* A node in the data flow graph that represents an output of a call.
3838
*/
3939
class OutNode extends Node;
4040

4141
/**
42-
* A node in the data flow graph representing the value of an argument after
43-
* an operation that might have changed its state. For example, consider the
44-
* following C++ code:
42+
* A node in the data flow graph representing the value of some other node
43+
* after an operation that might have changed its state. A typical example is
44+
* an argument, which may have been modified by the callee. For example,
45+
* consider the following code calling a setter method:
4546
* ```
46-
* int a = 1;
47-
* increment(&a);
47+
* x.setFoo(y);
4848
* ```
49-
* The post-update node for `&a` represents the value of `&a` after
50-
* modification by the call to `increment`.
49+
* The post-update node for the argument node `x` is the node representing the
50+
* value of `x` after the field `foo` has been updated.
5151
*/
5252
class PostUpdateNode extends Node {
5353
/**
@@ -206,9 +206,8 @@ signature module InputSig {
206206
predicate parameterMatch(ParameterPosition ppos, ArgumentPosition apos);
207207

208208
/**
209-
* Holds if there is a simple local flow step from `node1` to `node2`. This
210-
* is the local flow predicate that's used as a building block in global
211-
* data flow. It may have less flow than the `localFlowStep` predicate.
209+
* Holds if there is a simple local flow step from `node1` to `node2`. These
210+
* are the value-preserving intra-callable flow steps.
212211
*/
213212
predicate simpleLocalFlowStep(Node node1, Node node2);
214213

shared/rangeanalysis/codeql/rangeanalysis/RangeAnalysis.qll

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ signature module Semantic {
175175
BasicBlock getBasicBlock();
176176

177177
/**
178-
* Gets the guard as an expression.
178+
* Gets the guard as an expression, if any.
179179
*/
180180
Expr asExpr();
181181

@@ -240,11 +240,11 @@ signature module Semantic {
240240
Type getExprType(Expr e);
241241

242242
/**
243-
* A single static single assignment (SSA) variable.
243+
* A static single-assignment (SSA) variable.
244244
*/
245245
class SsaVariable {
246246
/**
247-
* Gets the expression where this SSA variable is used.
247+
* Gets an expression reading the value of this SSA variable.
248248
*/
249249
Expr getAUse();
250250

0 commit comments

Comments
 (0)