Dataflow: Add missing qldoc and sync.

aschackmull · aschackmull · commit 2971784f9c2b · 2020-11-03T09:21:48.000+01:00
diff --git a/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImpl.qll b/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImpl.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImpl2.qll b/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImpl2.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImpl3.qll b/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImpl3.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImpl4.qll b/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImpl4.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImplLocal.qll b/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowImplLocal.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl.qll b/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl2.qll b/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl2.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl3.qll b/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl3.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl4.qll b/cpp/ql/src/semmle/code/cpp/ir/dataflow/internal/DataFlowImpl4.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl.qll b/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl2.qll b/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl2.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl3.qll b/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl3.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl4.qll b/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl4.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl5.qll b/csharp/ql/src/semmle/code/csharp/dataflow/internal/DataFlowImpl5.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl.qll b/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl2.qll b/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl2.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl3.qll b/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl3.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl4.qll b/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl4.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl5.qll b/java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl5.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/python/ql/src/semmle/python/dataflow/new/internal/DataFlowImpl.qll b/python/ql/src/semmle/python/dataflow/new/internal/DataFlowImpl.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/python/ql/src/semmle/python/dataflow/new/internal/DataFlowImpl2.qll b/python/ql/src/semmle/python/dataflow/new/internal/DataFlowImpl2.qll
@@ -3231,8 +3231,10 @@ private module FlowExploration {
       result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"
     }
 
+    /** Holds if this is a source in a forward-flow path. */
     predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }
 
+    /** Holds if this is a sink in a reverse-flow path. */
     predicate isRevSink() { this.(PartialPathNodeRev).isSink() }
   }
 
diff --git a/python/ql/src/semmle/python/dataflow/new/internal/DataFlowImpl3.qll b/python/ql/src/semmle/python/dataflow/new/internal/DataFlowImpl3.qll
diff --git a/python/ql/src/semmle/python/dataflow/new/internal/DataFlowImpl4.qll b/python/ql/src/semmle/python/dataflow/new/internal/DataFlowImpl4.qll

Original file line number	Diff line number	Diff line change
`@@ -3231,8 +3231,10 @@ private module FlowExploration {`
`3231`	`3231`	`result = " <" + this.(PartialPathNodeFwd).getCallContext().toString() + ">"`
`3232`	`3232`	`}`
`3233`	`3233`
	`3234`	`+ /** Holds if this is a source in a forward-flow path. */`
`3234`	`3235`	`predicate isFwdSource() { this.(PartialPathNodeFwd).isSource() }`
`3235`	`3236`
	`3237`	`+ /** Holds if this is a sink in a reverse-flow path. */`
`3236`	`3238`	`predicate isRevSink() { this.(PartialPathNodeRev).isSink() }`
`3237`	`3239`	`}`
`3238`	`3240`