Skip to content

Commit 7d48220

Browse files
author
Dave Bartolomeo
committed
C++/C#: Make QLDoc conform to style guide
1 parent 44c1c5a commit 7d48220

File tree

5 files changed

+95
-105
lines changed

5 files changed

+95
-105
lines changed

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

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ IRUserVariable getIRUserVariable(Language::Function func, Language::Variable var
1313
}
1414

1515
/**
16-
* Represents a variable referenced by the IR for a function. The variable may
17-
* be a user-declared variable (`IRUserVariable`) or a temporary variable
18-
* generated by the AST-to-IR translation (`IRTempVariable`).
16+
* A variable referenced by the IR for a function. The variable may be a user-declared variable
17+
* (`IRUserVariable`) or a temporary variable generated by the AST-to-IR translation
18+
* (`IRTempVariable`).
1919
*/
2020
class IRVariable extends TIRVariable {
2121
Language::Function func;
@@ -78,7 +78,7 @@ class IRVariable extends TIRVariable {
7878
}
7979

8080
/**
81-
* Represents a user-declared variable referenced by the IR for a function.
81+
* A user-declared variable referenced by the IR for a function.
8282
*/
8383
class IRUserVariable extends IRVariable, TIRUserVariable {
8484
Language::Variable var;
@@ -103,9 +103,8 @@ class IRUserVariable extends IRVariable, TIRUserVariable {
103103
}
104104

105105
/**
106-
* Represents a variable (user-declared or temporary) that is allocated on the
107-
* stack. This includes all parameters, non-static local variables, and
108-
* temporary variables.
106+
* A variable (user-declared or temporary) that is allocated on the stack. This includes all
107+
* parameters, non-static local variables, and temporary variables.
109108
*/
110109
class IRAutomaticVariable extends IRVariable {
111110
IRAutomaticVariable() {
@@ -119,8 +118,8 @@ class IRAutomaticVariable extends IRVariable {
119118
}
120119

121120
/**
122-
* Represents a user-declared variable that is allocated on the stack. This
123-
* includes all parameters and non-static local variables.
121+
* A user-declared variable that is allocated on the stack. This includes all parameters and
122+
* non-static local variables.
124123
*/
125124
class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
126125
override Language::AutomaticVariable var;
@@ -129,9 +128,8 @@ class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
129128
}
130129

131130
/**
132-
* Represents a user-declared variable that is not allocated on the stack. This
133-
* includes all global variables, namespace-scope variables, static fields, and
134-
* static local variables.
131+
* A user-declared variable that is not allocated on the stack. This includes all global variables,
132+
* namespace-scope variables, static fields, and static local variables.
135133
*/
136134
class IRStaticUserVariable extends IRUserVariable {
137135
override Language::StaticVariable var;
@@ -142,8 +140,8 @@ class IRStaticUserVariable extends IRUserVariable {
142140
}
143141

144142
/**
145-
* Represents a variable that is not user-declared. This includes temporary
146-
* variables generated as part of IR construction, as well as string literals.
143+
* A variable that is not user-declared. This includes temporary variables generated as part of IR
144+
* construction, as well as string literals.
147145
*/
148146
class IRGeneratedVariable extends IRVariable {
149147
Language::AST ast;
@@ -176,9 +174,9 @@ IRTempVariable getIRTempVariable(Language::AST ast, TempVariableTag tag) {
176174
}
177175

178176
/**
179-
* Represents a temporary variable introduced by IR construction. The most common examples are the
180-
* variable generated to hold the return value of afunction, or the variable generated to hold the
181-
* result of a condition operator (`a ? b : c`).
177+
* A temporary variable introduced by IR construction. The most common examples are the variable
178+
* generated to hold the return value of afunction, or the variable generated to hold the result of
179+
* a condition operator (`a ? b : c`).
182180
*/
183181
class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVariable {
184182
TempVariableTag tag;
@@ -195,7 +193,7 @@ class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVa
195193
}
196194

197195
/**
198-
* The temporary variable generated to hold the return value of a function.
196+
* A temporary variable generated to hold the return value of a function.
199197
*/
200198
class IRReturnVariable extends IRTempVariable {
201199
IRReturnVariable() { tag = ReturnValueTempVar() }
@@ -204,7 +202,7 @@ class IRReturnVariable extends IRTempVariable {
204202
}
205203

206204
/**
207-
* The temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
205+
* A temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
208206
*/
209207
class IRThrowVariable extends IRTempVariable {
210208
IRThrowVariable() { tag = ThrowTempVar() }
@@ -213,8 +211,8 @@ class IRThrowVariable extends IRTempVariable {
213211
}
214212

215213
/**
216-
* The variable generated to represent the contents of a string literal. This variable acts much
217-
* like a read-only global variable.
214+
* A variable generated to represent the contents of a string literal. This variable acts much like
215+
* a read-only global variable.
218216
*/
219217
class IRStringLiteral extends IRGeneratedVariable, TIRStringLiteral {
220218
Language::StringLiteral literal;

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

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ IRUserVariable getIRUserVariable(Language::Function func, Language::Variable var
1313
}
1414

1515
/**
16-
* Represents a variable referenced by the IR for a function. The variable may
17-
* be a user-declared variable (`IRUserVariable`) or a temporary variable
18-
* generated by the AST-to-IR translation (`IRTempVariable`).
16+
* A variable referenced by the IR for a function. The variable may be a user-declared variable
17+
* (`IRUserVariable`) or a temporary variable generated by the AST-to-IR translation
18+
* (`IRTempVariable`).
1919
*/
2020
class IRVariable extends TIRVariable {
2121
Language::Function func;
@@ -78,7 +78,7 @@ class IRVariable extends TIRVariable {
7878
}
7979

8080
/**
81-
* Represents a user-declared variable referenced by the IR for a function.
81+
* A user-declared variable referenced by the IR for a function.
8282
*/
8383
class IRUserVariable extends IRVariable, TIRUserVariable {
8484
Language::Variable var;
@@ -103,9 +103,8 @@ class IRUserVariable extends IRVariable, TIRUserVariable {
103103
}
104104

105105
/**
106-
* Represents a variable (user-declared or temporary) that is allocated on the
107-
* stack. This includes all parameters, non-static local variables, and
108-
* temporary variables.
106+
* A variable (user-declared or temporary) that is allocated on the stack. This includes all
107+
* parameters, non-static local variables, and temporary variables.
109108
*/
110109
class IRAutomaticVariable extends IRVariable {
111110
IRAutomaticVariable() {
@@ -119,8 +118,8 @@ class IRAutomaticVariable extends IRVariable {
119118
}
120119

121120
/**
122-
* Represents a user-declared variable that is allocated on the stack. This
123-
* includes all parameters and non-static local variables.
121+
* A user-declared variable that is allocated on the stack. This includes all parameters and
122+
* non-static local variables.
124123
*/
125124
class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
126125
override Language::AutomaticVariable var;
@@ -129,9 +128,8 @@ class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
129128
}
130129

131130
/**
132-
* Represents a user-declared variable that is not allocated on the stack. This
133-
* includes all global variables, namespace-scope variables, static fields, and
134-
* static local variables.
131+
* A user-declared variable that is not allocated on the stack. This includes all global variables,
132+
* namespace-scope variables, static fields, and static local variables.
135133
*/
136134
class IRStaticUserVariable extends IRUserVariable {
137135
override Language::StaticVariable var;
@@ -142,8 +140,8 @@ class IRStaticUserVariable extends IRUserVariable {
142140
}
143141

144142
/**
145-
* Represents a variable that is not user-declared. This includes temporary
146-
* variables generated as part of IR construction, as well as string literals.
143+
* A variable that is not user-declared. This includes temporary variables generated as part of IR
144+
* construction, as well as string literals.
147145
*/
148146
class IRGeneratedVariable extends IRVariable {
149147
Language::AST ast;
@@ -176,9 +174,9 @@ IRTempVariable getIRTempVariable(Language::AST ast, TempVariableTag tag) {
176174
}
177175

178176
/**
179-
* Represents a temporary variable introduced by IR construction. The most common examples are the
180-
* variable generated to hold the return value of afunction, or the variable generated to hold the
181-
* result of a condition operator (`a ? b : c`).
177+
* A temporary variable introduced by IR construction. The most common examples are the variable
178+
* generated to hold the return value of afunction, or the variable generated to hold the result of
179+
* a condition operator (`a ? b : c`).
182180
*/
183181
class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVariable {
184182
TempVariableTag tag;
@@ -195,7 +193,7 @@ class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVa
195193
}
196194

197195
/**
198-
* The temporary variable generated to hold the return value of a function.
196+
* A temporary variable generated to hold the return value of a function.
199197
*/
200198
class IRReturnVariable extends IRTempVariable {
201199
IRReturnVariable() { tag = ReturnValueTempVar() }
@@ -204,7 +202,7 @@ class IRReturnVariable extends IRTempVariable {
204202
}
205203

206204
/**
207-
* The temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
205+
* A temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
208206
*/
209207
class IRThrowVariable extends IRTempVariable {
210208
IRThrowVariable() { tag = ThrowTempVar() }
@@ -213,8 +211,8 @@ class IRThrowVariable extends IRTempVariable {
213211
}
214212

215213
/**
216-
* The variable generated to represent the contents of a string literal. This variable acts much
217-
* like a read-only global variable.
214+
* A variable generated to represent the contents of a string literal. This variable acts much like
215+
* a read-only global variable.
218216
*/
219217
class IRStringLiteral extends IRGeneratedVariable, TIRStringLiteral {
220218
Language::StringLiteral literal;

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

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ IRUserVariable getIRUserVariable(Language::Function func, Language::Variable var
1313
}
1414

1515
/**
16-
* Represents a variable referenced by the IR for a function. The variable may
17-
* be a user-declared variable (`IRUserVariable`) or a temporary variable
18-
* generated by the AST-to-IR translation (`IRTempVariable`).
16+
* A variable referenced by the IR for a function. The variable may be a user-declared variable
17+
* (`IRUserVariable`) or a temporary variable generated by the AST-to-IR translation
18+
* (`IRTempVariable`).
1919
*/
2020
class IRVariable extends TIRVariable {
2121
Language::Function func;
@@ -78,7 +78,7 @@ class IRVariable extends TIRVariable {
7878
}
7979

8080
/**
81-
* Represents a user-declared variable referenced by the IR for a function.
81+
* A user-declared variable referenced by the IR for a function.
8282
*/
8383
class IRUserVariable extends IRVariable, TIRUserVariable {
8484
Language::Variable var;
@@ -103,9 +103,8 @@ class IRUserVariable extends IRVariable, TIRUserVariable {
103103
}
104104

105105
/**
106-
* Represents a variable (user-declared or temporary) that is allocated on the
107-
* stack. This includes all parameters, non-static local variables, and
108-
* temporary variables.
106+
* A variable (user-declared or temporary) that is allocated on the stack. This includes all
107+
* parameters, non-static local variables, and temporary variables.
109108
*/
110109
class IRAutomaticVariable extends IRVariable {
111110
IRAutomaticVariable() {
@@ -119,8 +118,8 @@ class IRAutomaticVariable extends IRVariable {
119118
}
120119

121120
/**
122-
* Represents a user-declared variable that is allocated on the stack. This
123-
* includes all parameters and non-static local variables.
121+
* A user-declared variable that is allocated on the stack. This includes all parameters and
122+
* non-static local variables.
124123
*/
125124
class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
126125
override Language::AutomaticVariable var;
@@ -129,9 +128,8 @@ class IRAutomaticUserVariable extends IRUserVariable, IRAutomaticVariable {
129128
}
130129

131130
/**
132-
* Represents a user-declared variable that is not allocated on the stack. This
133-
* includes all global variables, namespace-scope variables, static fields, and
134-
* static local variables.
131+
* A user-declared variable that is not allocated on the stack. This includes all global variables,
132+
* namespace-scope variables, static fields, and static local variables.
135133
*/
136134
class IRStaticUserVariable extends IRUserVariable {
137135
override Language::StaticVariable var;
@@ -142,8 +140,8 @@ class IRStaticUserVariable extends IRUserVariable {
142140
}
143141

144142
/**
145-
* Represents a variable that is not user-declared. This includes temporary
146-
* variables generated as part of IR construction, as well as string literals.
143+
* A variable that is not user-declared. This includes temporary variables generated as part of IR
144+
* construction, as well as string literals.
147145
*/
148146
class IRGeneratedVariable extends IRVariable {
149147
Language::AST ast;
@@ -176,9 +174,9 @@ IRTempVariable getIRTempVariable(Language::AST ast, TempVariableTag tag) {
176174
}
177175

178176
/**
179-
* Represents a temporary variable introduced by IR construction. The most common examples are the
180-
* variable generated to hold the return value of afunction, or the variable generated to hold the
181-
* result of a condition operator (`a ? b : c`).
177+
* A temporary variable introduced by IR construction. The most common examples are the variable
178+
* generated to hold the return value of afunction, or the variable generated to hold the result of
179+
* a condition operator (`a ? b : c`).
182180
*/
183181
class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVariable {
184182
TempVariableTag tag;
@@ -195,7 +193,7 @@ class IRTempVariable extends IRGeneratedVariable, IRAutomaticVariable, TIRTempVa
195193
}
196194

197195
/**
198-
* The temporary variable generated to hold the return value of a function.
196+
* A temporary variable generated to hold the return value of a function.
199197
*/
200198
class IRReturnVariable extends IRTempVariable {
201199
IRReturnVariable() { tag = ReturnValueTempVar() }
@@ -204,7 +202,7 @@ class IRReturnVariable extends IRTempVariable {
204202
}
205203

206204
/**
207-
* The temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
205+
* A temporary variable generated to hold the exception thrown by a `ThrowValue` instruction.
208206
*/
209207
class IRThrowVariable extends IRTempVariable {
210208
IRThrowVariable() { tag = ThrowTempVar() }
@@ -213,8 +211,8 @@ class IRThrowVariable extends IRTempVariable {
213211
}
214212

215213
/**
216-
* The variable generated to represent the contents of a string literal. This variable acts much
217-
* like a read-only global variable.
214+
* A variable generated to represent the contents of a string literal. This variable acts much like
215+
* a read-only global variable.
218216
*/
219217
class IRStringLiteral extends IRGeneratedVariable, TIRStringLiteral {
220218
Language::StringLiteral literal;

0 commit comments

Comments
 (0)