Maven is a build tool like Ant, with something like a project management function. You can make, test, deploy, create a project site, and much more. On the project site, other than the project documentation, you can register "Report" type plugins (like Javadoc and JUnit test reports), which will automatically be created when building the site. The DocCheck plugin adds a DocCheck report to this site.
DocCheck is an extension to the Javadoc tool that reviews Javadoc comments in the source code, identifying gaps and irregularities. It produces an HTML report that separates serious problems from trivial ones, and makes "suggestions" in the form of templates that show you what is needed. (Those suggestions can then be copied into the code and edited.) DocCheck recursively examines directories, and can be instructed to ignore packages and classes using fully-qualified wildcard patterns.
Due to limitations in the Doc Check Doclet 1.2b2, the output goes to a "null" directory if not specified. You can either specify the output directory, or apply a patch to fix this problem.
In order to specify the output directory,
-d . to the
additionalparam section in the configuration:
<configuration> <doclet>com.sun.tools.doclets.doccheck.DocCheck</doclet> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> <additionalparam>-d .</additionalparam> </configuration>
Due to a bug in the Doc Check Doclet 1.2b2, any individually specified classes are marked as anonymous package. You need to apply a patch to fix this problem.