Plugin Documentation
Goals available for this plugin:
| Goal | Report? | Description |
|---|---|---|
| javadoc:aggregate | Yes | Generates documentation for the Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project. |
| javadoc:aggregate-jar | No | Bundles the Javadoc documentation for main Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. |
| javadoc:aggregate-no-fork | Yes | Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool. |
| javadoc:fix | No | Fix Javadoc documentation and tags for the Java code for the project.See also: Where Tags Can Be Used |
| javadoc:help | No | Display help information on maven-javadoc-plugin.
Call mvn javadoc:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
| javadoc:jar | No | Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool. |
| javadoc:javadoc | Yes | Generates documentation for the Java code in a NON aggregator project using the standard Javadoc Tool.See also: Javadoc Tool |
| javadoc:javadoc-no-fork | Yes | Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of sources before site generation, e.g. by invoking mvn clean deploy site.See also: Javadoc Tool, Javadoc Options |
| javadoc:resource-bundle | No | Bundle javadocDirectory, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. |
| javadoc:test-aggregate | Yes | Generates documentation for the Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project. |
| javadoc:test-aggregate-jar | No | Bundles the Javadoc documentation for Since version 3.1.0 an aggregated jar is created for every module of a Maven multimodule project. |
| javadoc:test-aggregate-no-fork | Yes | Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool. |
| javadoc:test-fix | No | Fix Javadoc documentation and tags for the Test Java code for the project.See also: Where Tags Can Be Used |
| javadoc:test-jar | No | Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool. |
| javadoc:test-javadoc | Yes | Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.See also: Javadoc Tool |
| javadoc:test-javadoc-no-fork | Yes | Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool. Note that this goal does require generation of test sources before site generation, e.g. by invoking mvn clean deploy site.See also: Javadoc Tool, Javadoc Options |
| javadoc:test-resource-bundle | No | Bundle TestJavadocJar.testJavadocDirectory, along with javadoc configuration options from includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself. |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
| Maven | 3.2.5 |
| JDK | 1.8 |
Usage
You should specify the version in your project's plugin configuration:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.3</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
...
</plugins>
</build>
...
<!-- To use the report goals in your POM or parent POM -->
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.3</version>
</plugin>
...
</plugins>
</reporting>
...
</project>For more information, see "Guide to Configuring Plug-ins"