Plugin Documentation

Goals available for this plugin:

Goal Report? Description
jxr:aggregate Yes Generates a combined JXR report in an aggregating project.
jxr:help No Display help information on maven-jxr-plugin.
Call mvn jxr:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
jxr:jxr Yes Creates an html-based, cross referenced version of Java source code for a project.
jxr:jxr-no-fork Yes Creates an html-based, cross referenced version of Java source code for a project with forking. Note that this goal does require generation of sources before site generation, e.g. by invoking mvn clean deploy site.
jxr:test-aggregate Yes Generates a combined JXR report for test code in an aggregating project.
jxr:test-jxr Yes Creates an html-based, cross referenced version of Java source code for a project's test sources.
jxr:test-jxr-no-fork Yes Creates an html-based, cross referenced version of Java source code for a project's test sources without forking. Note that this goal does require generation of test sources before site generation, e.g. by invoking mvn clean deploy site.

System Requirements

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

Maven 3.1.1
JDK 1.7
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-jxr-plugin</artifactId>
          <version>3.1.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-jxr-plugin</artifactId>
        <version>3.1.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-jxr-plugin</artifactId>
        <version>3.1.1</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

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