C++: Improve QLDoc.

geoffw0 · geoffw0 · commit 8fbbc2b6d81b · 2024-03-26T11:21:25.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
@@ -1154,7 +1154,8 @@ class SummaryCall extends DataFlowCall, TSummaryCall {
   SummaryCall() { this = TSummaryCall(c, receiver) }
 
   /**
-   * Gets the data flow node that this call targets.
+   * Gets the data flow node that holds the address of the function this call
+   * targets.
    */
   FlowSummaryImpl::Private::SummaryNode getReceiver() { result = receiver }
 
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
@@ -747,7 +747,7 @@ class FlowSummaryNode extends Node, TFlowSummaryNode {
   FlowSummaryImpl::Private::SummaryNode getSummaryNode() { this = TFlowSummaryNode(result) }
 
   /**
-   * TODO: QLDoc.
+   * Gets the summarized callable that this node belongs to.
    */
   FlowSummaryImpl::Public::SummarizedCallable getSummarizedCallable() {
     result = this.getSummaryNode().getSummarizedCallable()
