Skip to content

Commit 26c81ea

Browse files
committed
C++: Mention localExpr{Flow,Taint} in module QLDoc
1 parent f1d7fde commit 26c81ea

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

cpp/ql/src/semmle/code/cpp/dataflow/DataFlow.qll

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@
1111
*
1212
* To use global (interprocedural) data flow, extend the class
1313
* `DataFlow::Configuration` as documented on that class. To use local
14-
* (intraprocedural) data flow, invoke `DataFlow::localFlow` or
15-
* `DataFlow::LocalFlowStep` with arguments of type `DataFlow::Node`.
14+
* (intraprocedural) data flow between expressions, call
15+
* `DataFlow::localExprFlow`. For more general cases of local data flow, call
16+
* `DataFlow::localFlow` or `DataFlow::localFlowStep` with arguments of type
17+
* `DataFlow::Node`.
1618
*/
1719
import cpp
1820

cpp/ql/src/semmle/code/cpp/dataflow/TaintTracking.qll

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66
* the information from the source is preserved at the sink. For example, taint
77
* propagates from `x` to `x + 100`, but it does not propagate from `x` to `x >
88
* 100` since we consider a single bit of information to be too little.
9+
*
10+
* To use global (interprocedural) taint tracking, extend the class
11+
* `TaintTracking::Configuration` as documented on that class. To use local
12+
* (intraprocedural) taint tracking between expressions, call
13+
* `TaintTracking::localExprTaint`. For more general cases of local taint
14+
* tracking, call `TaintTracking::localTaint` or
15+
* `TaintTracking::localTaintStep` with arguments of type `DataFlow::Node`.
916
*/
1017
import semmle.code.cpp.dataflow.DataFlow
1118
import semmle.code.cpp.dataflow.DataFlow2

0 commit comments

Comments
 (0)