forked from checkstyle/checkstyle
-
Notifications
You must be signed in to change notification settings - Fork 2
/
MissingJavadocPackageCheck.xml
26 lines (26 loc) · 1.08 KB
/
MissingJavadocPackageCheck.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
<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
<module>
<check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck"
name="MissingJavadocPackage"
parent="com.puppycrawl.tools.checkstyle.TreeWalker">
<description><p>
Checks for missing package definition Javadoc comments in package-info.java files.
</p>
<p>
Rationale: description and other related documentation for a package can be written up
in the package-info.java file and it gets used in the production of the Javadocs.
See <a
href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#packagecomment"
>link</a> for more info.
</p>
<p>
This check specifically only validates package definitions. It will not validate any methods or
interfaces declared in the package-info.java file.
</p></description>
<message-keys>
<message-key key="package.javadoc.missing"/>
</message-keys>
</check>
</module>
</checkstyle-metadata>