C++: Add more QLDoc.

MathiasVP · MathiasVP · commit 368f4387547f · 2023-12-14T14:49:48.000Z
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
@@ -2288,6 +2288,10 @@ private module ContentStars {
     result = "*" + repeatStars(n - 1)
   }
 
+  /**
+   * Gets the number of stars (i.e., `*`s) needed to produce the `toString`
+   * output for `c`.
+   */
   string contentStars(Content c) { result = repeatStars(c.getIndirectionIndex() - 1) }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -2288,6 +2288,10 @@ private module ContentStars {`
`2288`	`2288`	`result = "*" + repeatStars(n - 1)`
`2289`	`2289`	`}`
`2290`	`2290`
	`2291`	`+ /**`
	`2292`	+ * Gets the number of stars (i.e., `*`s) needed to produce the `toString`
	`2293`	+ * output for `c`.
	`2294`	`+ */`
`2291`	`2295`	`string contentStars(Content c) { result = repeatStars(c.getIndirectionIndex() - 1) }`
`2292`	`2296`	`}`
`2293`	`2297`