C++/C#: Document ReturnIndirectionInstruction::getParameter

Author: Robert Marsh

cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/Instruction.qll

@@ -536,6 +536,10 @@ class ReturnIndirectionInstruction extends VariableInstruction {
 
   final Instruction getSourceAddress() { result = getSourceAddressOperand().getDef() }
 
+  /**
+   * Gets the parameter for which this instruction reads the final pointed-to value within the
+   * function.
+   */
   final Language::Parameter getParameter() { result = var.(IRUserVariable).getVariable() }
 }
 

cpp/ql/src/semmle/code/cpp/ir/implementation/raw/Instruction.qll

@@ -536,6 +536,10 @@ class ReturnIndirectionInstruction extends VariableInstruction {
 
   final Instruction getSourceAddress() { result = getSourceAddressOperand().getDef() }
 
+  /**
+   * Gets the parameter for which this instruction reads the final pointed-to value within the
+   * function.
+   */
   final Language::Parameter getParameter() { result = var.(IRUserVariable).getVariable() }
 }
 

cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/Instruction.qll

@@ -536,6 +536,10 @@ class ReturnIndirectionInstruction extends VariableInstruction {
 
   final Instruction getSourceAddress() { result = getSourceAddressOperand().getDef() }
 
+  /**
+   * Gets the parameter for which this instruction reads the final pointed-to value within the
+   * function.
+   */
   final Language::Parameter getParameter() { result = var.(IRUserVariable).getVariable() }
 }
 

csharp/ql/src/semmle/code/csharp/ir/implementation/raw/Instruction.qll

@@ -536,6 +536,10 @@ class ReturnIndirectionInstruction extends VariableInstruction {
 
   final Instruction getSourceAddress() { result = getSourceAddressOperand().getDef() }
 
+  /**
+   * Gets the parameter for which this instruction reads the final pointed-to value within the
+   * function.
+   */
   final Language::Parameter getParameter() { result = var.(IRUserVariable).getVariable() }
 }
 

csharp/ql/src/semmle/code/csharp/ir/implementation/unaliased_ssa/Instruction.qll

@@ -536,6 +536,10 @@ class ReturnIndirectionInstruction extends VariableInstruction {
 
   final Instruction getSourceAddress() { result = getSourceAddressOperand().getDef() }
 
+  /**
+   * Gets the parameter for which this instruction reads the final pointed-to value within the
+   * function.
+   */
   final Language::Parameter getParameter() { result = var.(IRUserVariable).getVariable() }
 }