Plugin Documentation

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: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 source into a jar.
Note: the aggregate parameter is always set to false.
javadoc:javadoc Yes Generates documentation for the Java code in the project using the standard Javadoc Tool.
javadoc:test-aggregate Yes Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.
javadoc:test-jar No Bundles the Javadoc documentation for test source in a jar.
Note: the aggregate parameter is always set to false.
javadoc:test-javadoc Yes Generates documentation for the Java Test code in the project using the standard Javadoc Tool.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 2.0.9
JDK 1.4
Memory No minimum requirement.
Disk Space No minimum requirement.

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>2.5</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.5</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.5</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"