C++: Fix QLDoc on 'getAllocationAddressOperand' and 'getAllocationAddress'.

MathiasVP · MathiasVP · commit 5969c227abc9 · 2021-09-22T13:32:20.000+01:00
diff --git a/cpp/ql/lib/semmle/code/cpp/ir/implementation/aliased_ssa/Instruction.qll b/cpp/ql/lib/semmle/code/cpp/ir/implementation/aliased_ssa/Instruction.qll
@@ -1856,12 +1856,12 @@ class InitializeDynamicAllocationInstruction extends SideEffectInstruction {
   }
 
   /**
-   * Gets the address of the allocation this instruction is initializing.
+   * Gets the operand of the allocation this instruction is initializing.
    */
   final AddressOperand getAllocationAddressOperand() { result = getAnOperand() }
 
   /**
-   * Gets the operand for the allocation this instruction is initializing.
+   * Gets the address for the allocation this instruction is initializing.
    */
   final Instruction getAllocationAddress() { result = getAllocationAddressOperand().getDef() }
 }

Original file line number	Diff line number	Diff line change
`@@ -1856,12 +1856,12 @@ class InitializeDynamicAllocationInstruction extends SideEffectInstruction {`
`1856`	`1856`	`}`
`1857`	`1857`
`1858`	`1858`	`/**`
`1859`		`- * Gets the address of the allocation this instruction is initializing.`
	`1859`	`+ * Gets the operand of the allocation this instruction is initializing.`
`1860`	`1860`	`*/`
`1861`	`1861`	`final AddressOperand getAllocationAddressOperand() { result = getAnOperand() }`
`1862`	`1862`
`1863`	`1863`	`/**`
`1864`		`- * Gets the operand for the allocation this instruction is initializing.`
	`1864`	`+ * Gets the address for the allocation this instruction is initializing.`
`1865`	`1865`	`*/`
`1866`	`1866`	`final Instruction getAllocationAddress() { result = getAllocationAddressOperand().getDef() }`
`1867`	`1867`	`}`