Skip to content

Commit 911f154

Browse files
committed
DataFlow: Adjust QLDoc.
1 parent 339bf13 commit 911f154

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowPrivate.qll

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,14 +1151,16 @@ private int countNumberOfBranchesUsingParameter(SwitchInstruction switch, Parame
11511151
}
11521152

11531153
/**
1154-
* Holds if the dataflow step from `node1` to `node2` should not be used when
1155-
* computing flow-through summaries because the dataflow step copies the value
1156-
* of `node1` to `node2` in a way that does not preserve the identity of the
1157-
* value. For example the assignment to `x` that reads the value of `*p` in:
1154+
* Holds if the data-flow step from `node1` to `node2` can be used to
1155+
* determine where side-effects may return from a callable.
1156+
* For C/C++, this means that the step from `node1` to `node2` not only
1157+
* preserves the value, but also preserves the identity of the value.
1158+
* For example, the assignment to `x` that reads the value of `*p` in
11581159
* ```cpp
11591160
* int* p = ...
11601161
* int x = *p;
11611162
* ```
1163+
* does not preserve the identity of `*p`.
11621164
*/
11631165
bindingset[node1, node2]
11641166
pragma[inline_late]

shared/dataflow/codeql/dataflow/DataFlow.qll

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ signature module InputSig {
171171
predicate simpleLocalFlowStep(Node node1, Node node2);
172172

173173
/**
174-
* Holds if the data flow step from `node1` to `node2` can be used when
175-
* computing flow-through summaries.
174+
* Holds if the data-flow step from `node1` to `node2` can be used to
175+
* determine where side-effects may return from a callable.
176176
*/
177177
bindingset[node1, node2]
178178
default predicate validParameterAliasStep(Node node1, Node node2) { any() }

0 commit comments

Comments
 (0)