File tree Expand file tree Collapse file tree 1 file changed +5
-0
lines changed
java/ql/src/Advisory/Documentation Expand file tree Collapse file tree 1 file changed +5
-0
lines changed Original file line number Diff line number Diff line change
1
+ /** Provides classes and predicates related to Javadoc conventions. */
2
+
1
3
import java
2
4
3
5
/** Holds if the given `Javadoc` contains a minimum of a few characters of text. */
@@ -29,6 +31,7 @@ class DocuRefType extends RefType {
29
31
this .isPublic ( )
30
32
}
31
33
34
+ /** Holds if the Javadoc for this type contains a minimum of a few characters of text. */
32
35
predicate hasAcceptableDocText ( ) { acceptableDocText ( this .getDoc ( ) .getJavadoc ( ) ) }
33
36
}
34
37
@@ -46,8 +49,10 @@ class DocuCallable extends Callable {
46
49
not this .getLocation ( ) = this .getDeclaringType ( ) .getLocation ( )
47
50
}
48
51
52
+ /** Holds if the Javadoc for this callable contains a minimum of a few characters of text. */
49
53
predicate hasAcceptableDocText ( ) { acceptableDocText ( this .getDoc ( ) .getJavadoc ( ) ) }
50
54
55
+ /** Gets a string to identify whether this callable is a "method" or a "constructor". */
51
56
string toMethodOrConstructorString ( ) {
52
57
this instanceof Method and result = "method"
53
58
or
You can’t perform that action at this time.
0 commit comments