Built by Maven

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

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 without 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 test source code for a project.
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.6.3
JDK 1.8

System Requirements History

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

Plugin Version Maven JDK
from 3.4.0 to 3.5.0 3.6.3 8
from 3.2.0 to 3.3.2 3.2.5 8
3.1.1 3.1.1 7
3.0.0 3.0 7
2.5 2.2.1 5
2.4 2.0.9 5
2.3 2.0.9 1.4
2.2 2.0.6 1.4
2.1 2.0 -
2.0 - -

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

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