C++: Update QLDoc.

geoffw0 · geoffw0 · commit ec515f967d42 · 2024-04-08T11:57:35.000+01:00
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
@@ -544,7 +544,7 @@ class ReturnIndirectionNode extends IndirectReturnNode, ReturnNode {
 }
 
 /**
- * An return node that is part of a summary.
+ * A return node that is part of a summary.
  */
 private class SummaryReturnNode extends ReturnNode, FlowSummaryNode {
   private ReturnKind rk;
@@ -711,7 +711,10 @@ private class SideEffectOutNode extends OutNode, IndirectArgumentOutNode {
 }
 
 /**
- * An output node that is part of a summary.
+ * An output node that is part of a summary. An output node is needed when the
+ * model contains a synthesized call (`SummaryCall`) and the return value of
+ * that call is needed by the summary (for example when the model has flow from
+ * `Argument[0].ReturnValue`).
  */
 private class SummaryOutNode extends OutNode, FlowSummaryNode {
   private SummaryCall call;
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/DataFlowUtil.qll
@@ -1813,7 +1813,9 @@ abstract private class PartialDefinitionNode extends PostUpdateNode {
 }
 
 /**
- * TODO: QLDoc.
+ * A `PostUpdateNode` that is part of a flow summary. These are synthesized,
+ * for example, when a models-as-data summary models a write to a field since
+ * the write needs to target a `PostUpdateNode`.
  */
 class SummaryPostUpdateNode extends FlowSummaryNode, PostUpdateNode {
   SummaryPostUpdateNode() {
