Checkstyle's PackageHtml-rule ignores package-info.java
-
05-07-2019 - |
Question
I use checkstyle to analyze my code. A useful rule is PackageHtml, that checks, if a package contains a Javadoc-description. But with newer java-version it's recommended to use package-info.java instead of package.html. Problem is, checkstyle ignores the package-info.java and reports a rule violation. How can checkstyle be configured to check for package-documentation, but accepts package.html and package-info.java?
Solution
What version of CheckStyle are you using ?
It seems to be an old bug closed late 2007.
Actually, the documentation mentions package-info as being the default!... but only with CheckStyle 5.x, not 4.4
The announce for CheckStyle5.0 beta1 is here.
CheckStyle 4.4 is the last one compatible with jdk1.4