C++: Add QLDoc to 'isDereference'.

MathiasVP · MathiasVP · commit 261ba8e02d9e · 2023-08-30T14:34:30.000+01:00
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/SsaInternalsCommon.qll b/cpp/ql/lib/semmle/code/cpp/ir/dataflow/internal/SsaInternalsCommon.qll
@@ -320,6 +320,14 @@ private module IteratorIndirections {
   }
 }
 
+/**
+ * Holds if `deref` is the result of loading the value at the address
+ * represented by `address`.
+ *
+ * If `additional = true` then the dereference comes from an `Indirection`
+ * class (such as a call to an iterator's `operator*`), and if
+ * `additional = false` the dereference is a `LoadInstruction`.
+ */
 predicate isDereference(Instruction deref, Operand address, boolean additional) {
   any(Indirection ind).isAdditionalDereference(deref, address) and
   additional = true

Original file line number	Diff line number	Diff line change
`@@ -320,6 +320,14 @@ private module IteratorIndirections {`
`320`	`320`	`}`
`321`	`321`	`}`
`322`	`322`
	`323`	`+/**`
	`324`	+ * Holds if `deref` is the result of loading the value at the address
	`325`	+ * represented by `address`.
	`326`	`+ *`
	`327`	+ * If `additional = true` then the dereference comes from an `Indirection`
	`328`	+ * class (such as a call to an iterator's `operator*`), and if
	`329`	+ * `additional = false` the dereference is a `LoadInstruction`.
	`330`	`+ */`
`323`	`331`	`predicate isDereference(Instruction deref, Operand address, boolean additional) {`
`324`	`332`	`any(Indirection ind).isAdditionalDereference(deref, address) and`
`325`	`333`	`additional = true`