Skip to content

Commit 59072f9

Browse files
authored
C++: Improve QLDoc.
1 parent dd8bead commit 59072f9

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

cpp/ql/src/Critical/MissingCheckScanf.ql

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ predicate isSource(ScanfFunctionCall call, int index, Instruction instr, ValueNu
3333
}
3434

3535
/**
36-
* Holds if `instr` is control-flow reachable in 0 or more steps from an a call
37-
* to a call to a `scanf`-like function.
36+
* Holds if `instr` is control-flow reachable in 0 or more steps from
37+
* a call to a `scanf`-like function.
3838
*/
3939
pragma[nomagic]
4040
predicate fwdFlow0(Instruction instr) {
@@ -94,6 +94,9 @@ private predicate fwdFlow(Instruction instr, ValueNumber vn) {
9494
* Holds if `instr` is part of a path from a call to a `scanf`-like function
9595
* that writes to a variable with value number `vn`, without passing through
9696
* redefinitions of the variable.
97+
*
98+
* Note: This predicate only holds for the `(intr, vn)` pairs that are also
99+
* control-flow reachable from an argument to a `scanf`-like function call.
97100
*/
98101
pragma[nomagic]
99102
predicate revFlow(Instruction instr, ValueNumber vn) {

0 commit comments

Comments
 (0)