C++: add missing docs for a toString predicate

redsun82 · web-flow · commit 160635ba3c07 · 2021-12-13T11:28:02.000Z
diff --git a/cpp/ql/lib/semmle/code/cpp/commons/Printf.qll b/cpp/ql/lib/semmle/code/cpp/commons/Printf.qll
@@ -22,6 +22,9 @@ class BufferWriteEstimationReason extends TBufferWriteEstimationReason {
     this = TValueFlowAnalysis()
   }
 
+  /**
+   * Returns a human readable representation of this reason
+   */
   string toString() {
     this = TTypeBoundsAnalysis() and result = "based on type bounds"
     or

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@ class BufferWriteEstimationReason extends TBufferWriteEstimationReason {`
`22`	`22`	`this = TValueFlowAnalysis()`
`23`	`23`	`}`
`24`	`24`
	`25`	`+ /**`
	`26`	`+ * Returns a human readable representation of this reason`
	`27`	`+ */`
`25`	`28`	`string toString() {`
`26`	`29`	`this = TTypeBoundsAnalysis() and result = "based on type bounds"`
`27`	`30`	`or`