Maven JXR Plugin

Usage

The JXR Plugin generates a cross-reference of the project's sources. Below are the different goals and configurations for the plugin.

Generate JXR as Part of Project Reports

To include the JXR report in the site generation process, insert the following in the <reporting> section of your pom.xml:

<project>
  ...
  <build>
    ...
  </build>
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jxr-plugin</artifactId>
        <version>3.3.2</version>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

The report will be generated when you execute:

mvn site

Explicitly Generate JXR Files

The JXR files for the project's main sources will be generated using this command:

mvn jxr:jxr

To generate JXR files for the project's test sources, execute this command:

mvn jxr:test-jxr