Merge pull request #1228 from jbj/ir-result-type-docs

Approved by dave-bartolomeo

Author: semmle-qlci

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

@@ -404,7 +404,7 @@ class Instruction extends Construction::TInstruction {
     result = Construction::getInstructionConvertedResultExpression(this) 
   }
 
-    /**
+  /**
    * Gets the unconverted `Expr` whose result is computed by this instruction, if any.
    */
   final Expr getUnconvertedResultExpression() {
@@ -414,6 +414,9 @@ class Instruction extends Construction::TInstruction {
   /**
    * Gets the type of the result produced by this instruction. If the
    * instruction does not produce a result, its result type will be `VoidType`.
+   *
+   * If `isGLValue()` holds, then the result type of this instruction should be
+   * thought of as "pointer to `getResultType()`".
    */
   final Type getResultType() {
     Construction::instructionHasType(this, result, _)

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

@@ -404,7 +404,7 @@ class Instruction extends Construction::TInstruction {
     result = Construction::getInstructionConvertedResultExpression(this) 
   }
 
-    /**
+  /**
    * Gets the unconverted `Expr` whose result is computed by this instruction, if any.
    */
   final Expr getUnconvertedResultExpression() {
@@ -414,6 +414,9 @@ class Instruction extends Construction::TInstruction {
   /**
    * Gets the type of the result produced by this instruction. If the
    * instruction does not produce a result, its result type will be `VoidType`.
+   *
+   * If `isGLValue()` holds, then the result type of this instruction should be
+   * thought of as "pointer to `getResultType()`".
    */
   final Type getResultType() {
     Construction::instructionHasType(this, result, _)

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

@@ -404,7 +404,7 @@ class Instruction extends Construction::TInstruction {
     result = Construction::getInstructionConvertedResultExpression(this) 
   }
 
-    /**
+  /**
    * Gets the unconverted `Expr` whose result is computed by this instruction, if any.
    */
   final Expr getUnconvertedResultExpression() {
@@ -414,6 +414,9 @@ class Instruction extends Construction::TInstruction {
   /**
    * Gets the type of the result produced by this instruction. If the
    * instruction does not produce a result, its result type will be `VoidType`.
+   *
+   * If `isGLValue()` holds, then the result type of this instruction should be
+   * thought of as "pointer to `getResultType()`".
    */
   final Type getResultType() {
     Construction::instructionHasType(this, result, _)