Merge pull request github#3860 from dbartol/codeql-c-analysis-team/40/2

jbj · web-flow · commit 62a656de0fba · 2020-07-02T08:32:44.000+02:00
C++: QLDoc cleanup
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/IRBlock.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/IRBlock.qll
@@ -27,13 +27,17 @@ class IRBlockBase extends TIRBlock {
   final Language::Location getLocation() { result = getFirstInstruction().getLocation() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string that uniquely identifies this block within its enclosing function.
    *
    * This predicate is used by debugging and printing code only.
    */
   final string getUniqueId() { result = getFirstInstruction(this).getUniqueId() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the zero-based index of the block within its function.
    *
    * This predicate is used by debugging and printing code only.
@@ -67,7 +71,7 @@ class IRBlockBase extends TIRBlock {
   }
 
   /**
-   * Get the instructions in this block, including `Phi` instructions.
+   * Gets an instruction in this block. This includes `Phi` instructions.
    */
   final Instruction getAnInstruction() {
     result = getInstruction(_) or
@@ -111,12 +115,12 @@ class IRBlockBase extends TIRBlock {
  */
 class IRBlock extends IRBlockBase {
   /**
-   * Gets the blocks to which control flows directly from this block.
+   * Gets a block to which control flows directly from this block.
    */
   final IRBlock getASuccessor() { blockSuccessor(this, result) }
 
   /**
-   * Gets the blocks from which control flows directly to this block.
+   * Gets a block from which control flows directly to this block.
    */
   final IRBlock getAPredecessor() { blockSuccessor(result, this) }
 
@@ -156,7 +160,7 @@ class IRBlock extends IRBlockBase {
   final predicate dominates(IRBlock block) { strictlyDominates(block) or this = block }
 
   /**
-   * Gets the set of blocks on the dominance frontier of this block.
+   * Gets a block on the dominance frontier of this block.
    *
    * The dominance frontier of block `A` is the set of blocks `B` such that block `A` does not
    * dominate block `B`, but block `A` does dominate an immediate predecessor of block `B`.
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/IRVariable.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/IRVariable.qll
@@ -164,6 +164,8 @@ class IRGeneratedVariable extends IRVariable {
   override string getUniqueId() { none() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string containing the source code location of the AST that generated this variable.
    *
    * This is used by debugging and printing code only.
@@ -175,6 +177,8 @@ class IRGeneratedVariable extends IRVariable {
   }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the string that is combined with the location of the variable to generate the string
    * representation of this variable.
    *
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/Instruction.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/aliased_ssa/Instruction.qll
@@ -1989,7 +1989,7 @@ class BuiltInOperationInstruction extends Instruction {
   }
 
   /**
-   * Gets the language-specific `BuildInOperation` object that specifies the operation that is
+   * Gets the language-specific `BuiltInOperation` object that specifies the operation that is
    * performed by this instruction.
    */
   final Language::BuiltInOperation getBuiltInOperation() { result = operation }
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/raw/IRBlock.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/raw/IRBlock.qll
@@ -27,13 +27,17 @@ class IRBlockBase extends TIRBlock {
   final Language::Location getLocation() { result = getFirstInstruction().getLocation() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string that uniquely identifies this block within its enclosing function.
    *
    * This predicate is used by debugging and printing code only.
    */
   final string getUniqueId() { result = getFirstInstruction(this).getUniqueId() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the zero-based index of the block within its function.
    *
    * This predicate is used by debugging and printing code only.
@@ -67,7 +71,7 @@ class IRBlockBase extends TIRBlock {
   }
 
   /**
-   * Get the instructions in this block, including `Phi` instructions.
+   * Gets an instruction in this block. This includes `Phi` instructions.
    */
   final Instruction getAnInstruction() {
     result = getInstruction(_) or
@@ -111,12 +115,12 @@ class IRBlockBase extends TIRBlock {
  */
 class IRBlock extends IRBlockBase {
   /**
-   * Gets the blocks to which control flows directly from this block.
+   * Gets a block to which control flows directly from this block.
    */
   final IRBlock getASuccessor() { blockSuccessor(this, result) }
 
   /**
-   * Gets the blocks from which control flows directly to this block.
+   * Gets a block from which control flows directly to this block.
    */
   final IRBlock getAPredecessor() { blockSuccessor(result, this) }
 
@@ -156,7 +160,7 @@ class IRBlock extends IRBlockBase {
   final predicate dominates(IRBlock block) { strictlyDominates(block) or this = block }
 
   /**
-   * Gets the set of blocks on the dominance frontier of this block.
+   * Gets a block on the dominance frontier of this block.
    *
    * The dominance frontier of block `A` is the set of blocks `B` such that block `A` does not
    * dominate block `B`, but block `A` does dominate an immediate predecessor of block `B`.
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/raw/IRVariable.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/raw/IRVariable.qll
@@ -164,6 +164,8 @@ class IRGeneratedVariable extends IRVariable {
   override string getUniqueId() { none() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string containing the source code location of the AST that generated this variable.
    *
    * This is used by debugging and printing code only.
@@ -175,6 +177,8 @@ class IRGeneratedVariable extends IRVariable {
   }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the string that is combined with the location of the variable to generate the string
    * representation of this variable.
    *
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/raw/Instruction.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/raw/Instruction.qll
@@ -1989,7 +1989,7 @@ class BuiltInOperationInstruction extends Instruction {
   }
 
   /**
-   * Gets the language-specific `BuildInOperation` object that specifies the operation that is
+   * Gets the language-specific `BuiltInOperation` object that specifies the operation that is
    * performed by this instruction.
    */
   final Language::BuiltInOperation getBuiltInOperation() { result = operation }
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/IRBlock.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/IRBlock.qll
@@ -27,13 +27,17 @@ class IRBlockBase extends TIRBlock {
   final Language::Location getLocation() { result = getFirstInstruction().getLocation() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string that uniquely identifies this block within its enclosing function.
    *
    * This predicate is used by debugging and printing code only.
    */
   final string getUniqueId() { result = getFirstInstruction(this).getUniqueId() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the zero-based index of the block within its function.
    *
    * This predicate is used by debugging and printing code only.
@@ -67,7 +71,7 @@ class IRBlockBase extends TIRBlock {
   }
 
   /**
-   * Get the instructions in this block, including `Phi` instructions.
+   * Gets an instruction in this block. This includes `Phi` instructions.
    */
   final Instruction getAnInstruction() {
     result = getInstruction(_) or
@@ -111,12 +115,12 @@ class IRBlockBase extends TIRBlock {
  */
 class IRBlock extends IRBlockBase {
   /**
-   * Gets the blocks to which control flows directly from this block.
+   * Gets a block to which control flows directly from this block.
    */
   final IRBlock getASuccessor() { blockSuccessor(this, result) }
 
   /**
-   * Gets the blocks from which control flows directly to this block.
+   * Gets a block from which control flows directly to this block.
    */
   final IRBlock getAPredecessor() { blockSuccessor(result, this) }
 
@@ -156,7 +160,7 @@ class IRBlock extends IRBlockBase {
   final predicate dominates(IRBlock block) { strictlyDominates(block) or this = block }
 
   /**
-   * Gets the set of blocks on the dominance frontier of this block.
+   * Gets a block on the dominance frontier of this block.
    *
    * The dominance frontier of block `A` is the set of blocks `B` such that block `A` does not
    * dominate block `B`, but block `A` does dominate an immediate predecessor of block `B`.
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/IRVariable.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/IRVariable.qll
@@ -164,6 +164,8 @@ class IRGeneratedVariable extends IRVariable {
   override string getUniqueId() { none() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string containing the source code location of the AST that generated this variable.
    *
    * This is used by debugging and printing code only.
@@ -175,6 +177,8 @@ class IRGeneratedVariable extends IRVariable {
   }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the string that is combined with the location of the variable to generate the string
    * representation of this variable.
    *
diff --git a/cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/Instruction.qll b/cpp/ql/src/semmle/code/cpp/ir/implementation/unaliased_ssa/Instruction.qll
@@ -1989,7 +1989,7 @@ class BuiltInOperationInstruction extends Instruction {
   }
 
   /**
-   * Gets the language-specific `BuildInOperation` object that specifies the operation that is
+   * Gets the language-specific `BuiltInOperation` object that specifies the operation that is
    * performed by this instruction.
    */
   final Language::BuiltInOperation getBuiltInOperation() { result = operation }
diff --git a/csharp/ql/src/experimental/ir/implementation/raw/IRBlock.qll b/csharp/ql/src/experimental/ir/implementation/raw/IRBlock.qll
@@ -27,13 +27,17 @@ class IRBlockBase extends TIRBlock {
   final Language::Location getLocation() { result = getFirstInstruction().getLocation() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string that uniquely identifies this block within its enclosing function.
    *
    * This predicate is used by debugging and printing code only.
    */
   final string getUniqueId() { result = getFirstInstruction(this).getUniqueId() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the zero-based index of the block within its function.
    *
    * This predicate is used by debugging and printing code only.
@@ -67,7 +71,7 @@ class IRBlockBase extends TIRBlock {
   }
 
   /**
-   * Get the instructions in this block, including `Phi` instructions.
+   * Gets an instruction in this block. This includes `Phi` instructions.
    */
   final Instruction getAnInstruction() {
     result = getInstruction(_) or
@@ -111,12 +115,12 @@ class IRBlockBase extends TIRBlock {
  */
 class IRBlock extends IRBlockBase {
   /**
-   * Gets the blocks to which control flows directly from this block.
+   * Gets a block to which control flows directly from this block.
    */
   final IRBlock getASuccessor() { blockSuccessor(this, result) }
 
   /**
-   * Gets the blocks from which control flows directly to this block.
+   * Gets a block from which control flows directly to this block.
    */
   final IRBlock getAPredecessor() { blockSuccessor(result, this) }
 
@@ -156,7 +160,7 @@ class IRBlock extends IRBlockBase {
   final predicate dominates(IRBlock block) { strictlyDominates(block) or this = block }
 
   /**
-   * Gets the set of blocks on the dominance frontier of this block.
+   * Gets a block on the dominance frontier of this block.
    *
    * The dominance frontier of block `A` is the set of blocks `B` such that block `A` does not
    * dominate block `B`, but block `A` does dominate an immediate predecessor of block `B`.
diff --git a/csharp/ql/src/experimental/ir/implementation/raw/IRVariable.qll b/csharp/ql/src/experimental/ir/implementation/raw/IRVariable.qll
@@ -164,6 +164,8 @@ class IRGeneratedVariable extends IRVariable {
   override string getUniqueId() { none() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string containing the source code location of the AST that generated this variable.
    *
    * This is used by debugging and printing code only.
@@ -175,6 +177,8 @@ class IRGeneratedVariable extends IRVariable {
   }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the string that is combined with the location of the variable to generate the string
    * representation of this variable.
    *
diff --git a/csharp/ql/src/experimental/ir/implementation/raw/Instruction.qll b/csharp/ql/src/experimental/ir/implementation/raw/Instruction.qll
@@ -1989,7 +1989,7 @@ class BuiltInOperationInstruction extends Instruction {
   }
 
   /**
-   * Gets the language-specific `BuildInOperation` object that specifies the operation that is
+   * Gets the language-specific `BuiltInOperation` object that specifies the operation that is
    * performed by this instruction.
    */
   final Language::BuiltInOperation getBuiltInOperation() { result = operation }
diff --git a/csharp/ql/src/experimental/ir/implementation/unaliased_ssa/IRBlock.qll b/csharp/ql/src/experimental/ir/implementation/unaliased_ssa/IRBlock.qll
@@ -27,13 +27,17 @@ class IRBlockBase extends TIRBlock {
   final Language::Location getLocation() { result = getFirstInstruction().getLocation() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string that uniquely identifies this block within its enclosing function.
    *
    * This predicate is used by debugging and printing code only.
    */
   final string getUniqueId() { result = getFirstInstruction(this).getUniqueId() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the zero-based index of the block within its function.
    *
    * This predicate is used by debugging and printing code only.
@@ -67,7 +71,7 @@ class IRBlockBase extends TIRBlock {
   }
 
   /**
-   * Get the instructions in this block, including `Phi` instructions.
+   * Gets an instruction in this block. This includes `Phi` instructions.
    */
   final Instruction getAnInstruction() {
     result = getInstruction(_) or
@@ -111,12 +115,12 @@ class IRBlockBase extends TIRBlock {
  */
 class IRBlock extends IRBlockBase {
   /**
-   * Gets the blocks to which control flows directly from this block.
+   * Gets a block to which control flows directly from this block.
    */
   final IRBlock getASuccessor() { blockSuccessor(this, result) }
 
   /**
-   * Gets the blocks from which control flows directly to this block.
+   * Gets a block from which control flows directly to this block.
    */
   final IRBlock getAPredecessor() { blockSuccessor(result, this) }
 
@@ -156,7 +160,7 @@ class IRBlock extends IRBlockBase {
   final predicate dominates(IRBlock block) { strictlyDominates(block) or this = block }
 
   /**
-   * Gets the set of blocks on the dominance frontier of this block.
+   * Gets a block on the dominance frontier of this block.
    *
    * The dominance frontier of block `A` is the set of blocks `B` such that block `A` does not
    * dominate block `B`, but block `A` does dominate an immediate predecessor of block `B`.
diff --git a/csharp/ql/src/experimental/ir/implementation/unaliased_ssa/IRVariable.qll b/csharp/ql/src/experimental/ir/implementation/unaliased_ssa/IRVariable.qll
@@ -164,6 +164,8 @@ class IRGeneratedVariable extends IRVariable {
   override string getUniqueId() { none() }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets a string containing the source code location of the AST that generated this variable.
    *
    * This is used by debugging and printing code only.
@@ -175,6 +177,8 @@ class IRGeneratedVariable extends IRVariable {
   }
 
   /**
+   * INTERNAL: Do not use.
+   *
    * Gets the string that is combined with the location of the variable to generate the string
    * representation of this variable.
    *
diff --git a/csharp/ql/src/experimental/ir/implementation/unaliased_ssa/Instruction.qll b/csharp/ql/src/experimental/ir/implementation/unaliased_ssa/Instruction.qll
@@ -1989,7 +1989,7 @@ class BuiltInOperationInstruction extends Instruction {
   }
 
   /**
-   * Gets the language-specific `BuildInOperation` object that specifies the operation that is
+   * Gets the language-specific `BuiltInOperation` object that specifies the operation that is
    * performed by this instruction.
    */
   final Language::BuiltInOperation getBuiltInOperation() { result = operation }

Original file line number	Diff line number	Diff line change
`@@ -164,6 +164,8 @@ class IRGeneratedVariable extends IRVariable {`
`164`	`164`	`override string getUniqueId() { none() }`
`165`	`165`
`166`	`166`	`/**`
	`167`	`+ * INTERNAL: Do not use.`
	`168`	`+ *`
`167`	`169`	`* Gets a string containing the source code location of the AST that generated this variable.`
`168`	`170`	`*`
`169`	`171`	`* This is used by debugging and printing code only.`
`@@ -175,6 +177,8 @@ class IRGeneratedVariable extends IRVariable {`
`175`	`177`	`}`
`176`	`178`
`177`	`179`	`/**`
	`180`	`+ * INTERNAL: Do not use.`
	`181`	`+ *`
`178`	`182`	`* Gets the string that is combined with the location of the variable to generate the string`
`179`	`183`	`* representation of this variable.`
`180`	`184`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1989,7 +1989,7 @@ class BuiltInOperationInstruction extends Instruction {`
`1989`	`1989`	`}`
`1990`	`1990`
`1991`	`1991`	`/**`
`1992`		- * Gets the language-specific `BuildInOperation` object that specifies the operation that is
	`1992`	+ * Gets the language-specific `BuiltInOperation` object that specifies the operation that is
`1993`	`1993`	`* performed by this instruction.`
`1994`	`1994`	`*/`
`1995`	`1995`	`final Language::BuiltInOperation getBuiltInOperation() { result = operation }`