Skip to content

Commit 57c1bf5

Browse files
committed
C++: Add file-level QLDoc.
1 parent 497592a commit 57c1bf5

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

cpp/ql/lib/semmle/code/cpp/models/interfaces/PartialFlow.qll

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
/**
2+
* Provides an abstract class to override the implicit assumption that a
3+
* dataflow/taint-tracking model always fully override the parameters they are
4+
* are modelled as writing to. To use this QL library, create a QL class
5+
* extending `PartialFlowFunction` with a characteristic predicate that selects
6+
* the function or set of functions you are modeling and override the
7+
* `isPartialWrite` predicate.
8+
*
9+
* Note: Since both `DataFlowFunction` and `TaintFunction` extend this class
10+
* you don't need to explicitly add this as a base class if your QL class
11+
* already extends either `DataFlowFunction` or `TaintFunction`.
12+
*/
13+
114
import semmle.code.cpp.Function
215
import FunctionInputsAndOutputs
316
import semmle.code.cpp.models.Models

0 commit comments

Comments
 (0)