Goals available for this plugin:
Goal | Report? | Description |
---|---|---|
javadoc:aggregate | Yes | Generates documentation for the Java code in an
aggregator project using the standard Javadoc
Tool. |
javadoc:aggregate-jar | No | Bundles the Javadoc documentation for main Java code
in an aggregator project into a jar using the standard Javadoc
Tool. |
javadoc:fix | No | Fix Javadoc documentation and tags for the Java code
for the project. See 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 an NON
aggregator project using the standard Javadoc
Tool. |
javadoc:resource-bundle | No | Bundle AbstractJavadocMojo.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 Java Test code in an
aggregator project using the standard Javadoc
Tool. |
javadoc:test-aggregate-jar | No | Bundles the Javadoc documentation for Java Test code
in an aggregator project into a jar using the standard Javadoc
Tool. |
javadoc:test-fix | No | Fix Javadoc documentation and tags for the Test Java
code for the project. See 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. |
javadoc:test-resource-bundle | No | Bundle TestJavadocJar.testJavadocDirectory , along with
javadoc configuration options from AbstractJavadocMojo
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. |
The following specifies the minimum requirements to run this Maven plugin:
Maven | 2.2.1 |
JDK | 1.5 |
Memory | No minimum requirement. |
Disk Space | No minimum requirement. |
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>2.9.1</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> <version>2.9.1</version> </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>2.9.1</version> </plugin> ... </plugins> </reporting> ... </project>
For more information, see "Guide to Configuring Plug-ins"