Skip to content

Commit 53ccbee

Browse files
committed
Java: add missing QLDoc for JavadocCommon.qll
1 parent e33ebdc commit 53ccbee

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

java/ql/src/Advisory/Documentation/JavadocCommon.qll

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** Provides classes and predicates related to Javadoc conventions. */
2+
13
import java
24

35
/** Holds if the given `Javadoc` contains a minimum of a few characters of text. */
@@ -29,6 +31,7 @@ class DocuRefType extends RefType {
2931
this.isPublic()
3032
}
3133

34+
/** Holds if the Javadoc for this type contains a minimum of a few characters of text. */
3235
predicate hasAcceptableDocText() { acceptableDocText(this.getDoc().getJavadoc()) }
3336
}
3437

@@ -46,8 +49,10 @@ class DocuCallable extends Callable {
4649
not this.getLocation() = this.getDeclaringType().getLocation()
4750
}
4851

52+
/** Holds if the Javadoc for this callable contains a minimum of a few characters of text. */
4953
predicate hasAcceptableDocText() { acceptableDocText(this.getDoc().getJavadoc()) }
5054

55+
/** Gets a string to identify whether this callable is a "method" or a "constructor". */
5156
string toMethodOrConstructorString() {
5257
this instanceof Method and result = "method"
5358
or

0 commit comments

Comments
 (0)