C++: QLDoc for IteratorPartialDefinitionNode

Robert Marsh · Robert Marsh · commit b84bf5e9bb5a · 2020-09-18T14:18:38.000-07:00
diff --git a/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowUtil.qll b/cpp/ql/src/semmle/code/cpp/dataflow/internal/DataFlowUtil.qll
@@ -304,6 +304,12 @@ private class VariablePartialDefinitionNode extends PartialDefinitionNode {
   override Node getPreUpdateNode() { pd.definesExpressions(_, result.asExpr()) }
 }
 
+/**
+ * INTERNAL: do not use.
+ * 
+ * A synthetic data flow node used for flow into a collection when an iterator
+ * write occurs in a callee.
+ */
 class IteratorPartialDefinitionNode extends PartialDefinitionNode {
   override IteratorPartialDefinition pd;
 
