Built by Maven

jxr:jxr-no-fork

Note:

This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-jxr-plugin:3.6.0:jxr-no-fork

Description:

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}.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 3.1.0.

Required Parameters

Name Type Since Description
<outputDirectory> File - The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().


Default: ${project.build.directory}/reports

Optional Parameters

Name Type Since Description
<bottom> String - String used at the bottom of the Xref HTML files.
Default: © {inceptionYear}–{currentYear} {organizationName}
User Property: bottom
<docTitle> String - Title of main page of the Xref HTML files.
Default: ${project.name} ${project.version} Reference
<excludes> ArrayList<String> 2.1 A list of exclude patterns to use. By default no files are excluded.
<includes> ArrayList<String> 2.1 A list of include patterns to use. By default all .java files are included.
<javadocLocation> File - Directory where Javadoc is generated for this project.
Default: org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory() + /apidocs
<javadocVersion> String - Version of the Javadoc templates to use. The value should reflect `java.specification.version`, "1.4", "1.8", "9", "10", by default this system property is used.
User Property: javadocVersion
<linkJavadoc> boolean - Link the Javadoc from the Source XRef. Defaults to true and will link automatically if javadoc plugin is being used.
Default: true
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)
Default: default
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<skip> boolean 2.3 Whether to skip this execution.
Default: false
User Property: maven.jxr.skip
<sourcePath> String - Specifies the source path where the java files are located. The paths are separated by ';'.
<stylesheet> String - Style sheet used for the Xref HTML files. Should not be used. If used, should be an absolute path, like "${basedir/myStyles.css"}.
<templateDir> String - Directory where Velocity templates can be found to generate overviews, frames and summaries. Should not be used. If used, should be an absolute path, like "${basedir/myTemplates"}.
<windowTitle> String - Title of window of the Xref HTML files.
Default: ${project.name} ${project.version} Reference

Parameter Details

<bottom>

String used at the bottom of the Xref HTML files.
  • Type: java.lang.String
  • Required: No
  • User Property: bottom
  • Default: © {inceptionYear}–{currentYear} {organizationName}

<docTitle>

Title of main page of the Xref HTML files.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name} ${project.version} Reference

<excludes>

A list of exclude patterns to use. By default no files are excluded.
  • Type: java.util.ArrayList<java.lang.String>
  • Since: 2.1
  • Required: No

<includes>

A list of include patterns to use. By default all .java files are included.
  • Type: java.util.ArrayList<java.lang.String>
  • Since: 2.1
  • Required: No

<javadocLocation>

Directory where Javadoc is generated for this project.
Default: org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory() + /apidocs
  • Type: java.io.File
  • Required: No

<javadocVersion>

Version of the Javadoc templates to use. The value should reflect `java.specification.version`, "1.4", "1.8", "9", "10", by default this system property is used.
  • Type: java.lang.String
  • Required: No
  • User Property: javadocVersion

<linkJavadoc>

Link the Javadoc from the Source XRef. Defaults to true and will link automatically if javadoc plugin is being used.
  • Type: boolean
  • Required: No
  • Default: true

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<outputDirectory>

The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/reports

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<skip>

Whether to skip this execution.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: maven.jxr.skip
  • Default: false

<sourcePath>

Specifies the source path where the java files are located. The paths are separated by ';'.
  • Type: java.lang.String
  • Required: No

<stylesheet>

Style sheet used for the Xref HTML files. Should not be used. If used, should be an absolute path, like "${basedir/myStyles.css"}.
  • Type: java.lang.String
  • Required: No

<templateDir>

Directory where Velocity templates can be found to generate overviews, frames and summaries. Should not be used. If used, should be an absolute path, like "${basedir/myTemplates"}.
  • Type: java.lang.String
  • Required: No

<windowTitle>

Title of window of the Xref HTML files.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name} ${project.version} Reference