Merge pull request github#3392 from rdmarsh2/rdmarsh/cpp/qldoc-get-ConvertedResultExpression

C++/C#: improve qldoc on IR get*ResultExpression

Author: Dave Bartolomeo

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

@@ -190,14 +190,15 @@ class Instruction extends Construction::TInstruction {
   final Language::Location getLocation() { result = getAST().getLocation() }
 
   /**
-   * Gets the `Expr` whose result is computed by this instruction, if any.
+   * Gets the  `Expr` whose result is computed by this instruction, if any. The `Expr` may be a
+   * conversion.
    */
   final Language::Expr getConvertedResultExpression() {
     result = Construction::getInstructionConvertedResultExpression(this)
   }
 
   /**
-   * Gets the unconverted `Expr` whose result is computed by this instruction, if any.
+   * Gets the unconverted form of the `Expr` whose result is computed by this instruction, if any.
    */
   final Language::Expr getUnconvertedResultExpression() {
     result = Construction::getInstructionUnconvertedResultExpression(this)

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

@@ -190,14 +190,15 @@ class Instruction extends Construction::TInstruction {
   final Language::Location getLocation() { result = getAST().getLocation() }
 
   /**
-   * Gets the `Expr` whose result is computed by this instruction, if any.
+   * Gets the  `Expr` whose result is computed by this instruction, if any. The `Expr` may be a
+   * conversion.
    */
   final Language::Expr getConvertedResultExpression() {
     result = Construction::getInstructionConvertedResultExpression(this)
   }
 
   /**
-   * Gets the unconverted `Expr` whose result is computed by this instruction, if any.
+   * Gets the unconverted form of the `Expr` whose result is computed by this instruction, if any.
    */
   final Language::Expr getUnconvertedResultExpression() {
     result = Construction::getInstructionUnconvertedResultExpression(this)

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

@@ -190,14 +190,15 @@ class Instruction extends Construction::TInstruction {
   final Language::Location getLocation() { result = getAST().getLocation() }
 
   /**
-   * Gets the `Expr` whose result is computed by this instruction, if any.
+   * Gets the  `Expr` whose result is computed by this instruction, if any. The `Expr` may be a
+   * conversion.
    */
   final Language::Expr getConvertedResultExpression() {
     result = Construction::getInstructionConvertedResultExpression(this)
   }
 
   /**
-   * Gets the unconverted `Expr` whose result is computed by this instruction, if any.
+   * Gets the unconverted form of the `Expr` whose result is computed by this instruction, if any.
    */
   final Language::Expr getUnconvertedResultExpression() {
     result = Construction::getInstructionUnconvertedResultExpression(this)

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

@@ -190,14 +190,15 @@ class Instruction extends Construction::TInstruction {
   final Language::Location getLocation() { result = getAST().getLocation() }
 
   /**
-   * Gets the `Expr` whose result is computed by this instruction, if any.
+   * Gets the  `Expr` whose result is computed by this instruction, if any. The `Expr` may be a
+   * conversion.
    */
   final Language::Expr getConvertedResultExpression() {
     result = Construction::getInstructionConvertedResultExpression(this)
   }
 
   /**
-   * Gets the unconverted `Expr` whose result is computed by this instruction, if any.
+   * Gets the unconverted form of the `Expr` whose result is computed by this instruction, if any.
    */
   final Language::Expr getUnconvertedResultExpression() {
     result = Construction::getInstructionUnconvertedResultExpression(this)

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

@@ -190,14 +190,15 @@ class Instruction extends Construction::TInstruction {
   final Language::Location getLocation() { result = getAST().getLocation() }
 
   /**
-   * Gets the `Expr` whose result is computed by this instruction, if any.
+   * Gets the  `Expr` whose result is computed by this instruction, if any. The `Expr` may be a
+   * conversion.
    */
   final Language::Expr getConvertedResultExpression() {
     result = Construction::getInstructionConvertedResultExpression(this)
   }
 
   /**
-   * Gets the unconverted `Expr` whose result is computed by this instruction, if any.
+   * Gets the unconverted form of the `Expr` whose result is computed by this instruction, if any.
    */
   final Language::Expr getUnconvertedResultExpression() {
     result = Construction::getInstructionUnconvertedResultExpression(this)