Apache Maven 3 Cookbook

Chapter 9
Documentation for an Apache Maven plugin project can be automatically generated.
The command for doing so is as follows:
$ mvn site
2. Verify that plugin documentation adheres to the Maven community standards by
running the command:
$ mvn docck:check
How it works...
The mvn site command will automatically generate a plugin site for your plugin project
based on available information in the project POM file, the src/site folder, and available
reporting plugins.
The Maven plugin is an important reporting plugin as it leads to the generation of
documentation for each MOJO and thus for each plugin goal.
The first step for ensuring good documentation is to achieve completeness of the project's
POM file. Make sure all optional elements in the project object model are filled in including
organization details, names, descriptions, URLs, mailing lists, licenses, issue/bug trackers,
source code repositories, and so on.
There's more
Additional recommended reporting plugins for your Maven plugin project are:
ff
ff
Maven Javadoc plugin
Maven JXR plugin
The following example shows how both can be included in your pom.xml file in the
reporting element:
org.apache.maven.plugins
maven-javadoc-plugin
2.4
128m
512
197