Add QLDoc.

criemen · criemen · commit 1aa7a827afc8 · 2020-05-07T14:53:41.000+02:00
diff --git a/cpp/ql/src/semmle/code/cpp/rangeanalysis/Bound.qll b/cpp/ql/src/semmle/code/cpp/rangeanalysis/Bound.qll
@@ -68,7 +68,7 @@ class ValueNumberBound extends Bound, TBoundValueNumber {
 
   ValueNumberBound() { this = TBoundValueNumber(vn) }
 
-  /** Gets the SSA variable that equals this bound. */
+  /** Gets an `Instruction` that equals this bound. */
   override Instruction getInstruction(int delta) {
     this = TBoundValueNumber(valueNumber(result)) and delta = 0
   }
@@ -77,5 +77,6 @@ class ValueNumberBound extends Bound, TBoundValueNumber {
 
   override Location getLocation() { result = vn.getLocation() }
 
+  /** Gets the value number that equals this bound. */
   ValueNumber getValueNumber() { result = vn }
 }

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ class ValueNumberBound extends Bound, TBoundValueNumber {`
`68`	`68`
`69`	`69`	`ValueNumberBound() { this = TBoundValueNumber(vn) }`
`70`	`70`
`71`		`- /** Gets the SSA variable that equals this bound. */`
	`71`	+ /** Gets an `Instruction` that equals this bound. */
`72`	`72`	`override Instruction getInstruction(int delta) {`
`73`	`73`	`this = TBoundValueNumber(valueNumber(result)) and delta = 0`
`74`	`74`	`}`
`@@ -77,5 +77,6 @@ class ValueNumberBound extends Bound, TBoundValueNumber {`
`77`	`77`
`78`	`78`	`override Location getLocation() { result = vn.getLocation() }`
`79`	`79`
	`80`	`+ /** Gets the value number that equals this bound. */`
`80`	`81`	`ValueNumber getValueNumber() { result = vn }`
`81`	`82`	`}`