C++: Fill out some QLDoc.

geoffw0 · geoffw0 · commit d1fc700735fa · 2024-03-05T17:34:48.000Z
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowPrivate.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowPrivate.qll
@@ -392,7 +392,7 @@ private class SideEffectArgumentNode extends ArgumentNode, SideEffectOperandNode
 }
 
 /**
- * TODO: QLDoc.
+ * An argument node that is part of a summary.
  */
 class SummaryArgumentNode extends ArgumentNode, FlowSummaryNode {
   private SummaryCall call_;
@@ -550,6 +550,9 @@ class ReturnIndirectionNode extends IndirectReturnNode, ReturnNode {
   }
 }
 
+/**
+ * An return node that is part of a summary.
+ */
 private class SummaryReturnNode extends ReturnNode, FlowSummaryNode {
   private ReturnKind rk;
 
@@ -715,7 +718,7 @@ private class SideEffectOutNode extends OutNode, IndirectArgumentOutNode {
 }
 
 /**
- * TODO: QLDoc.
+ * An output node that is part of a summary.
  */
 private class SummaryOutNode extends OutNode, FlowSummaryNode {
   private SummaryCall call;

Original file line number	Diff line number	Diff line change
`@@ -392,7 +392,7 @@ private class SideEffectArgumentNode extends ArgumentNode, SideEffectOperandNode`
`392`	`392`	`}`
`393`	`393`
`394`	`394`	`/**`
`395`		`- * TODO: QLDoc.`
	`395`	`+ * An argument node that is part of a summary.`
`396`	`396`	`*/`
`397`	`397`	`class SummaryArgumentNode extends ArgumentNode, FlowSummaryNode {`
`398`	`398`	`private SummaryCall call_;`
`@@ -550,6 +550,9 @@ class ReturnIndirectionNode extends IndirectReturnNode, ReturnNode {`
`550`	`550`	`}`
`551`	`551`	`}`
`552`	`552`
	`553`	`+/**`
	`554`	`+ * An return node that is part of a summary.`
	`555`	`+ */`
`553`	`556`	`private class SummaryReturnNode extends ReturnNode, FlowSummaryNode {`
`554`	`557`	`private ReturnKind rk;`
`555`	`558`
`@@ -715,7 +718,7 @@ private class SideEffectOutNode extends OutNode, IndirectArgumentOutNode {`
`715`	`718`	`}`
`716`	`719`
`717`	`720`	`/**`
`718`		`- * TODO: QLDoc.`
	`721`	`+ * An output node that is part of a summary.`
`719`	`722`	`*/`
`720`	`723`	`private class SummaryOutNode extends OutNode, FlowSummaryNode {`
`721`	`724`	`private SummaryCall call;`