Execute maven.
maven plugin:download -DgroupId=doccheck -DartifactId=maven-doccheck-plugin -Dversion=1.4-0.1
Currently, the Maven DocCheck Plug-in only works for Maven 1. However, you can use the maven-javadoc-plugin to generate DocCheck reports.
Before doing anything else, install the doclet itself.
Add the following to the <reporting>
section of your pom.
<reporting> ... <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <reportSets> <reportSet> <id>doccheck</id> <configuration> <doclet>com.sun.tools.doclets.doccheck.DocCheck</doclet> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> </configuration> <reports> <report>javadoc</report> </reports> </reportSet> </reportSets> </plugin> </plugins> ... <reporting>
Most people who will use the Doc Check Doclet will also want to see the actual javadocs.
First, you must use a maven-javadoc-plugin version with MJAVADOC-81 applied. Currently, the only solution is to apply the patch and install it yourself.
Add the following to the <reporting>
section of your pom.
<reporting> ... <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.1-SNAPSHOT</version> <reportSets> <reportSet> <id>html</id> <reports> <report>javadoc</report> </reports> </reportSet> <reportSet> <id>doccheck</id> <configuration> <name>DocCheck</name> <description>DocCheck documentation</description> <doclet>com.sun.tools.doclets.doccheck.DocCheck</doclet> <docletArtifact> <groupId>com.sun.tools.doclets</groupId> <artifactId>doccheck</artifactId> <version>1.2b2</version> </docletArtifact> <destDir>doccheck</destDir> </configuration> <reports> <report>javadoc</report> </reports> </reportSet> </reportSets> </plugin> </plugins> ... <reporting>