Skip to content

Commit de9b936

Browse files
authored
QLDoc tidy up Declaration.qll
Mostly just adding backticks in QLDoc comments. I'm trying out the edit-in-github workflow @jbj showed me, which seems like it will be a quicker way to do minor changes like these.
1 parent 2df0509 commit de9b936

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

cpp/ql/src/semmle/code/cpp/Declaration.qll

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ private import semmle.code.cpp.internal.QualifiedName as Q
1111
* `DeclarationEntry`. Some declarations do not correspond to a unique
1212
* location in the source code. For example, a global variable might
1313
* be declared in multiple source files:
14-
*
14+
* ```
1515
* extern int myglobal;
16-
*
16+
* ```
1717
* Each of these declarations is given its own distinct `DeclarationEntry`,
1818
* but they all share the same `Declaration`.
1919
*
@@ -25,7 +25,7 @@ abstract class Declaration extends Locatable, @declaration {
2525
/**
2626
* Gets the innermost namespace which contains this declaration.
2727
*
28-
* The result will either be GlobalNamespace, or the tightest lexically
28+
* The result will either be `GlobalNamespace`, or the tightest lexically
2929
* enclosing namespace block. In particular, note that for declarations
3030
* within structures, the namespace of the declaration is the same as the
3131
* namespace of the structure.
@@ -231,7 +231,7 @@ abstract class Declaration extends Locatable, @declaration {
231231
* `DeclarationEntry`.
232232
*/
233233
abstract class DeclarationEntry extends Locatable {
234-
/** a specifier associated with this declaration entry */
234+
/** Gets a specifier associated with this declaration entry. */
235235
abstract string getASpecifier();
236236

237237
/**
@@ -249,12 +249,12 @@ abstract class DeclarationEntry extends Locatable {
249249
* Gets the declaration for which this is a declaration entry.
250250
*
251251
* Note that this is *not* always the inverse of
252-
* Declaration.getADeclarationEntry(), for example if C is a
253-
* TemplateClass, I is an instantiation of C, and D is a Declaration of
254-
* C, then:
255-
* C.getADeclarationEntry() returns D
256-
* I.getADeclarationEntry() returns D
257-
* but D.getDeclaration() only returns C
252+
* `Declaration.getADeclarationEntry()`, for example if `C` is a
253+
* `TemplateClass`, `I` is an instantiation of `C`, and `D` is a
254+
* `Declaration` of `C`, then:
255+
* `C.getADeclarationEntry()` returns `D`
256+
* `I.getADeclarationEntry()` returns `D`
257+
* but `D.getDeclaration()` only returns `C`
258258
*/
259259
abstract Declaration getDeclaration();
260260

@@ -329,7 +329,7 @@ abstract class AccessHolder extends Declaration {
329329
}
330330

331331
/**
332-
* Gets the nearest enclosing AccessHolder.
332+
* Gets the nearest enclosing `AccessHolder`.
333333
*/
334334
abstract AccessHolder getEnclosingAccessHolder();
335335

@@ -505,7 +505,7 @@ private class DirectAccessHolder extends Element {
505505
exists(Class p | p = derived.getADerivedClass*() |
506506
this.isFriendOfOrEqualTo(p) and
507507
// Note: it's crucial that this is `!=` rather than `not =` since
508-
// accessOfBaseMember does not have a result when the member would be
508+
// `accessOfBaseMember` does not have a result when the member would be
509509
// inaccessible.
510510
p.accessOfBaseMember(base, public) != public
511511
)

0 commit comments

Comments
 (0)