Since Checkstyle 5.0
Checks that each Java package has a Javadoc file used for
commenting. By default, it only allows a package-info.java
file, but can be
configured to allow a package.html
file.
A violation will be reported if both files exist as this is not allowed by the Javadoc tool.
To configure the check:
<module name="Checker"> <module name="JavadocPackage"/> </module>
To configure the check to use legacy package.html
file
when package-info.java
file is absent:
<module name="JavadocPackage"> <property name="allowLegacy" value="true"/> </module>
All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.
com.puppycrawl.tools.checkstyle.checks.javadoc