You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/qldoc-style-guide.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,6 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
32
32
1. Declarations in query files should be documented.
33
33
1. Library files (`.qll` files) should be have a documentation comment at the top of the file.
34
34
1. Query files, except for tests, must have a QLDoc query documentation comment at the top of the file.
35
-
1. Where a class denotes a generic concept with subclasses, list those subclasses.
36
35
37
36
## QLDoc for predicates
38
37
@@ -63,7 +62,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
63
62
64
63
### Predicates with result
65
64
66
-
1. Use a third-person verb phrase of the form `Gets (a|the) <thing>`.
65
+
1. Use a third-person verb phrase of the form `Gets (a|the) <thing>.`
67
66
1. Use "if any" if the item is usually unique but might be missing. For example
68
67
`Gets the body of this method, if any.`
69
68
1. If the predicate has more complex behaviour, for example multiple arguments are conceptually "outputs", it can be described like a predicate without a result. For example
@@ -79,7 +78,7 @@ Valid QL comments are known as QLDoc. This document describes the recommended st
79
78
/**
80
79
* Gets the expression denoting the super class of this class,
81
80
* or nothing if this is an interface or a class without an `extends` clause.
82
-
*/
81
+
*/
83
82
```
84
83
85
84
### Deprecated predicates
@@ -132,9 +131,10 @@ Certain special predicates should be documented consistently.
132
131
```
133
132
## QLDoc for classes
134
133
135
-
1. Document classes using a noun phrase of the form `A <domain element> that <has property>`.
134
+
1. Document classes using a noun phrase of the form `A <domain element> that <has property>.`
136
135
1. Use "that", not "which".
137
136
1. Refer to member elements in the singular.
137
+
1. Where a class denotes a generic concept with subclasses, list those subclasses.
138
138
139
139
#### Example
140
140
@@ -162,7 +162,7 @@ class Callable extends ...
162
162
163
163
## QLDoc for modules
164
164
165
-
Modules should be documented using a third-person verb phrase of the form `Provides <classes and predicates to do something>`.
165
+
Modules should be documented using a third-person verb phrase of the form `Provides <classes and predicates to do something>.`
0 commit comments