C++/C#: Make QLDoc conform to style guide

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

@@ -13,9 +13,9 @@ IRUserVariable getIRUserVariable(Language::Function func, Language::Variable var
 }
 
 /**
- * Represents a variable referenced by the IR for a function. The variable may
- * be a user-declared variable (`IRUserVariable`) or a temporary variable
- * generated by the AST-to-IR translation (`IRTempVariable`).
+ * A variable referenced by the IR for a function. The variable may be a user-declared variable
+ * (`IRUserVariable`) or a temporary variable generated by the AST-to-IR translation
+ * (`IRTempVariable`).
  */
 class IRVariable extends TIRVariable {
   Language::Function func;
@@ -78,7 +78,7 @@ class IRVariable extends TIRVariable {
 }
 
 /**
- * Represents a user-declared variable referenced by the IR for a function.
+ * A user-declared variable referenced by the IR for a function.
  */
 class IRUserVariable extends IRVariable, TIRUserVariable {
   Language::Variable var;
@@ -103,9 +103,8 @@ class IRUserVariable extends IRVariable, TIRUserVariable {
 }
 
 /**
- * Represents a variable (user-declared or temporary) that is allocated on the
- * stack. This includes all parameters, non-static local variables, and
- * temporary variables.
+ * A variable (user-declared or temporary) that is allocated on the stack. This includes all
+ * parameters, non-static local variables, and temporary variables.
  */
 class IRAutomaticVariable extends IRVariable {
   IRAutomaticVariable() {
@@ -119,8 +118,8 @@ class IRAutomaticVariable extends IRVariable {
 }
 
 /**
- * Represents a user-declared variable that is allocated on the stack. This
- * includes all parameters and non-static local variables.
+ * A user-declared variable that is allocated on the stack. This includes all parameters and
+ * non-static local variables.
  */
 class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
   override Language::AutomaticVariable var;
@@ -129,9 +128,8 @@ class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
 }
 
 /**
- * Represents a user-declared variable that is not allocated on the stack. This
- * includes all global variables, namespace-scope variables, static fields, and
- * static local variables.
+ * A user-declared variable that is not allocated on the stack. This includes all global variables,
+ * namespace-scope variables, static fields, and static local variables.
  */
 class IRStaticUserVariable extends IRUserVariable {
   override Language::StaticVariable var;
@@ -142,8 +140,8 @@ class IRStaticUserVariable extends IRUserVariable {
 }
 
 /**
- * Represents a variable that is not user-declared. This includes temporary
- * variables generated as part of IR construction, as well as string literals.
+ * A variable that is not user-declared. This includes temporary variables generated as part of IR
+ * construction, as well as string literals.
  */
 class IRGeneratedVariable extends IRVariable {
   Language::AST ast;
@@ -176,9 +174,9 @@ IRTempVariable getIRTempVariable(Language::AST ast, TempVariableTag tag) {
 }
 
 /**
- * Represents a temporary variable introduced by IR construction. The most common examples are the
- * variable generated to hold the return value of afunction, or the variable generated to hold the
- * result of a condition operator (`a ? b : c`).
+ * A temporary variable introduced by IR construction. The most common examples are the variable
+ * generated to hold the return value of afunction, or the variable generated to hold the result of
+ * a condition operator (`a ? b : c`).
  */
 class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVariable {
   TempVariableTag tag;
@@ -195,7 +193,7 @@ class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVa
 }
 
 /**
- * The temporary variable generated to hold the return value of a function.
+ * A temporary variable generated to hold the return value of a function.
  */
 class IRReturnVariable extends IRTempVariable {
   IRReturnVariable() { tag = ReturnValueTempVar() }
@@ -204,7 +202,7 @@ class IRReturnVariable extends IRTempVariable {
 }
 
 /**
- * The temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
+ * A temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
  */
 class IRThrowVariable extends IRTempVariable {
   IRThrowVariable() { tag = ThrowTempVar() }
@@ -213,8 +211,8 @@ class IRThrowVariable extends IRTempVariable {
 }
 
 /**
- * The variable generated to represent the contents of a string literal. This variable acts much
- * like a read-only global variable.
+ * A variable generated to represent the contents of a string literal. This variable acts much like
+ * a read-only global variable.
  */
 class IRStringLiteral extends IRGeneratedVariable, TIRStringLiteral {
   Language::StringLiteral literal;

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

@@ -13,9 +13,9 @@ IRUserVariable getIRUserVariable(Language::Function func, Language::Variable var
 }
 
 /**
- * Represents a variable referenced by the IR for a function. The variable may
- * be a user-declared variable (`IRUserVariable`) or a temporary variable
- * generated by the AST-to-IR translation (`IRTempVariable`).
+ * A variable referenced by the IR for a function. The variable may be a user-declared variable
+ * (`IRUserVariable`) or a temporary variable generated by the AST-to-IR translation
+ * (`IRTempVariable`).
  */
 class IRVariable extends TIRVariable {
   Language::Function func;
@@ -78,7 +78,7 @@ class IRVariable extends TIRVariable {
 }
 
 /**
- * Represents a user-declared variable referenced by the IR for a function.
+ * A user-declared variable referenced by the IR for a function.
  */
 class IRUserVariable extends IRVariable, TIRUserVariable {
   Language::Variable var;
@@ -103,9 +103,8 @@ class IRUserVariable extends IRVariable, TIRUserVariable {
 }
 
 /**
- * Represents a variable (user-declared or temporary) that is allocated on the
- * stack. This includes all parameters, non-static local variables, and
- * temporary variables.
+ * A variable (user-declared or temporary) that is allocated on the stack. This includes all
+ * parameters, non-static local variables, and temporary variables.
  */
 class IRAutomaticVariable extends IRVariable {
   IRAutomaticVariable() {
@@ -119,8 +118,8 @@ class IRAutomaticVariable extends IRVariable {
 }
 
 /**
- * Represents a user-declared variable that is allocated on the stack. This
- * includes all parameters and non-static local variables.
+ * A user-declared variable that is allocated on the stack. This includes all parameters and
+ * non-static local variables.
  */
 class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
   override Language::AutomaticVariable var;
@@ -129,9 +128,8 @@ class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
 }
 
 /**
- * Represents a user-declared variable that is not allocated on the stack. This
- * includes all global variables, namespace-scope variables, static fields, and
- * static local variables.
+ * A user-declared variable that is not allocated on the stack. This includes all global variables,
+ * namespace-scope variables, static fields, and static local variables.
  */
 class IRStaticUserVariable extends IRUserVariable {
   override Language::StaticVariable var;
@@ -142,8 +140,8 @@ class IRStaticUserVariable extends IRUserVariable {
 }
 
 /**
- * Represents a variable that is not user-declared. This includes temporary
- * variables generated as part of IR construction, as well as string literals.
+ * A variable that is not user-declared. This includes temporary variables generated as part of IR
+ * construction, as well as string literals.
  */
 class IRGeneratedVariable extends IRVariable {
   Language::AST ast;
@@ -176,9 +174,9 @@ IRTempVariable getIRTempVariable(Language::AST ast, TempVariableTag tag) {
 }
 
 /**
- * Represents a temporary variable introduced by IR construction. The most common examples are the
- * variable generated to hold the return value of afunction, or the variable generated to hold the
- * result of a condition operator (`a ? b : c`).
+ * A temporary variable introduced by IR construction. The most common examples are the variable
+ * generated to hold the return value of afunction, or the variable generated to hold the result of
+ * a condition operator (`a ? b : c`).
  */
 class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVariable {
   TempVariableTag tag;
@@ -195,7 +193,7 @@ class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVa
 }
 
 /**
- * The temporary variable generated to hold the return value of a function.
+ * A temporary variable generated to hold the return value of a function.
  */
 class IRReturnVariable extends IRTempVariable {
   IRReturnVariable() { tag = ReturnValueTempVar() }
@@ -204,7 +202,7 @@ class IRReturnVariable extends IRTempVariable {
 }
 
 /**
- * The temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
+ * A temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
  */
 class IRThrowVariable extends IRTempVariable {
   IRThrowVariable() { tag = ThrowTempVar() }
@@ -213,8 +211,8 @@ class IRThrowVariable extends IRTempVariable {
 }
 
 /**
- * The variable generated to represent the contents of a string literal. This variable acts much
- * like a read-only global variable.
+ * A variable generated to represent the contents of a string literal. This variable acts much like
+ * a read-only global variable.
  */
 class IRStringLiteral extends IRGeneratedVariable, TIRStringLiteral {
   Language::StringLiteral literal;

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

@@ -13,9 +13,9 @@ IRUserVariable getIRUserVariable(Language::Function func, Language::Variable var
 }
 
 /**
- * Represents a variable referenced by the IR for a function. The variable may
- * be a user-declared variable (`IRUserVariable`) or a temporary variable
- * generated by the AST-to-IR translation (`IRTempVariable`).
+ * A variable referenced by the IR for a function. The variable may be a user-declared variable
+ * (`IRUserVariable`) or a temporary variable generated by the AST-to-IR translation
+ * (`IRTempVariable`).
  */
 class IRVariable extends TIRVariable {
   Language::Function func;
@@ -78,7 +78,7 @@ class IRVariable extends TIRVariable {
 }
 
 /**
- * Represents a user-declared variable referenced by the IR for a function.
+ * A user-declared variable referenced by the IR for a function.
  */
 class IRUserVariable extends IRVariable, TIRUserVariable {
   Language::Variable var;
@@ -103,9 +103,8 @@ class IRUserVariable extends IRVariable, TIRUserVariable {
 }
 
 /**
- * Represents a variable (user-declared or temporary) that is allocated on the
- * stack. This includes all parameters, non-static local variables, and
- * temporary variables.
+ * A variable (user-declared or temporary) that is allocated on the stack. This includes all
+ * parameters, non-static local variables, and temporary variables.
  */
 class IRAutomaticVariable extends IRVariable {
   IRAutomaticVariable() {
@@ -119,8 +118,8 @@ class IRAutomaticVariable extends IRVariable {
 }
 
 /**
- * Represents a user-declared variable that is allocated on the stack. This
- * includes all parameters and non-static local variables.
+ * A user-declared variable that is allocated on the stack. This includes all parameters and
+ * non-static local variables.
  */
 class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
   override Language::AutomaticVariable var;
@@ -129,9 +128,8 @@ class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
 }
 
 /**
- * Represents a user-declared variable that is not allocated on the stack. This
- * includes all global variables, namespace-scope variables, static fields, and
- * static local variables.
+ * A user-declared variable that is not allocated on the stack. This includes all global variables,
+ * namespace-scope variables, static fields, and static local variables.
  */
 class IRStaticUserVariable extends IRUserVariable {
   override Language::StaticVariable var;
@@ -142,8 +140,8 @@ class IRStaticUserVariable extends IRUserVariable {
 }
 
 /**
- * Represents a variable that is not user-declared. This includes temporary
- * variables generated as part of IR construction, as well as string literals.
+ * A variable that is not user-declared. This includes temporary variables generated as part of IR
+ * construction, as well as string literals.
  */
 class IRGeneratedVariable extends IRVariable {
   Language::AST ast;
@@ -176,9 +174,9 @@ IRTempVariable getIRTempVariable(Language::AST ast, TempVariableTag tag) {
 }
 
 /**
- * Represents a temporary variable introduced by IR construction. The most common examples are the
- * variable generated to hold the return value of afunction, or the variable generated to hold the
- * result of a condition operator (`a ? b : c`).
+ * A temporary variable introduced by IR construction. The most common examples are the variable
+ * generated to hold the return value of afunction, or the variable generated to hold the result of
+ * a condition operator (`a ? b : c`).
  */
 class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVariable {
   TempVariableTag tag;
@@ -195,7 +193,7 @@ class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVa
 }
 
 /**
- * The temporary variable generated to hold the return value of a function.
+ * A temporary variable generated to hold the return value of a function.
  */
 class IRReturnVariable extends IRTempVariable {
   IRReturnVariable() { tag = ReturnValueTempVar() }
@@ -204,7 +202,7 @@ class IRReturnVariable extends IRTempVariable {
 }
 
 /**
- * The temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
+ * A temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
  */
 class IRThrowVariable extends IRTempVariable {
   IRThrowVariable() { tag = ThrowTempVar() }
@@ -213,8 +211,8 @@ class IRThrowVariable extends IRTempVariable {
 }
 
 /**
- * The variable generated to represent the contents of a string literal. This variable acts much
- * like a read-only global variable.
+ * A variable generated to represent the contents of a string literal. This variable acts much like
+ * a read-only global variable.
  */
 class IRStringLiteral extends IRGeneratedVariable, TIRStringLiteral {
   Language::StringLiteral literal;