Dataflow: Add qldoc.

aschackmull · aschackmull · commit fff3b5c5b45d · 2022-01-18T10:39:55.000+01:00
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl2.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl2.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl3.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl3.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl4.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImpl4.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImplLocal.qll b/cpp/ql/lib/semmle/code/cpp/dataflow/internal/DataFlowImplLocal.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl2.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl2.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl3.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl3.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl4.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl4.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl2.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl2.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl3.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl3.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl4.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl4.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl5.qll b/csharp/ql/lib/semmle/code/csharp/dataflow/internal/DataFlowImpl5.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl2.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl2.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl3.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl3.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl4.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl4.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl5.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl5.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl6.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl6.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImplForSerializability.qll b/java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImplForSerializability.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl2.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl2.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl3.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl3.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl4.qll b/python/ql/lib/semmle/python/dataflow/new/internal/DataFlowImpl4.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl.qll b/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
diff --git a/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl2.qll b/ruby/ql/lib/codeql/ruby/dataflow/internal/DataFlowImpl2.qll
@@ -3749,6 +3749,11 @@ module PathGraph {
     reach(n) and key = "semmle.label" and val = n.toString()
   }
 
+  /**
+   * Holds if `(arg, par, ret, out)` forms a subpath-tuple, that is, flow through
+   * a subpath between `par` and `ret` with the connecting edges `arg -> par` and
+   * `ret -> out` is summarized as the edge `arg -> out`.
+   */
   query predicate subpaths(PathNode arg, PathNode par, PathNode ret, PathNode out) {
     Subpaths::subpaths(arg, par, ret, out) and
     reach(arg) and
