C++: Add QLDoc to subpaths in DefaultTaintTracking

Robert Marsh · Robert Marsh · commit 3189c578a4ee · 2021-09-23T22:42:38.000-07:00
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/DefaultTaintTracking.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/DefaultTaintTracking.qll
@@ -550,6 +550,10 @@ module TaintedWithPath {
     )
   }
 
+  /**
+   * Holds if there is flow from `arg` to `out` across a call that can by summarized by the flow
+   * from `par` to `ret` within it, in the graph of data flow path explanations.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     DataFlow3::PathGraph::subpaths(arg.(WrapPathNode).inner(), par.(WrapPathNode).inner(),
       ret.(WrapPathNode).inner(), out.(WrapPathNode).inner())

Original file line number	Diff line number	Diff line change
`@@ -550,6 +550,10 @@ module TaintedWithPath {`
`550`	`550`	`)`
`551`	`551`	`}`
`552`	`552`
	`553`	`+ /**`
	`554`	+ * Holds if there is flow from `arg` to `out` across a call that can by summarized by the flow
	`555`	+ * from `par` to `ret` within it, in the graph of data flow path explanations.
	`556`	`+ */`
`553`	`557`	`query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {`
`554`	`558`	`DataFlow3::PathGraph::subpaths(arg.(WrapPathNode).inner(), par.(WrapPathNode).inner(),`
`555`	`559`	`ret.(WrapPathNode).inner(), out.(WrapPathNode).inner())`