/
MissingJavadocTypeCheck.xml
42 lines (42 loc) · 2 KB
/
MissingJavadocTypeCheck.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
<module>
<check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck"
name="MissingJavadocType"
parent="com.puppycrawl.tools.checkstyle.TreeWalker">
<description><p>
Checks for missing Javadoc comments for class, enum, interface, and annotation interface
definitions. The scope to verify is specified using the {@code Scope} class and defaults
to {@code Scope.PUBLIC}. To verify another scope, set property scope to one of the
{@code Scope} constants.
</p></description>
<properties>
<property default-value="public"
name="scope"
type="com.puppycrawl.tools.checkstyle.api.Scope">
<description>specify the visibility scope where Javadoc comments are checked.</description>
</property>
<property name="excludeScope" type="com.puppycrawl.tools.checkstyle.api.Scope">
<description>specify the visibility scope where Javadoc comments are not
checked.</description>
</property>
<property default-value="Generated"
name="skipAnnotations"
type="java.lang.String[]">
<description>specify annotations that allow missed
documentation. If annotation is present in target sources in multiple forms of qualified
name, all forms should be listed in this property.</description>
</property>
<property default-value="INTERFACE_DEF,CLASS_DEF,ENUM_DEF,ANNOTATION_DEF,RECORD_DEF"
name="tokens"
type="java.lang.String[]"
validation-type="tokenSet">
<description>tokens to check</description>
</property>
</properties>
<message-keys>
<message-key key="javadoc.missing"/>
</message-keys>
</check>
</module>
</checkstyle-metadata>