Maven JXR Plugin

jxr:jxr

Note:This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-jxr-plugin:3.2.0:jxr

Description:

Creates an html-based, cross referenced version of Java source code for a project.

Attributes:

Requires a Maven project to be executed.
The goal is not marked as thread-safe and thus does not support parallel builds.
Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

Required Parameters

Name	Type	Since	Description
`<outputDirectory>`	`File`	`-`	Output folder where the main page of the report will be generated. Note that this parameter is only relevant if the goal is run directly from the command line or from the default lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin will be used instead. Default value is: `${project.reporting.outputDirectory}`.

Optional Parameters

Name	Type	Since	Description
`<bottom>`	`String`	`-`	String used at the bottom of the Xref HTML files. Default value is: `Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved.`. User property is: `bottom`.
`<destDir>`	`String`	`-`	Folder where the Xref files will be copied to. Default value is: `${project.reporting.outputDirectory}/xref`.
`<docTitle>`	`String`	`-`	Title of main page of the Xref HTML files. Default value is: `${project.name} ${project.version} Reference`.
`<excludes>`	`ArrayList`	`2.1`	A list of exclude patterns to use. By default no files are excluded.
`<includes>`	`ArrayList`	`2.1`	A list of include patterns to use. By default all .java files are included.
`<inputEncoding>`	`String`	`-`	File input encoding. Default value is: `${project.build.sourceEncoding}`. User property is: `encoding`.
`<javadocDir>`	`File`	`-`	Folder where Javadoc is generated for this project. Default value is: `${project.reporting.outputDirectory}/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 is: `javadocVersion`.
`<linkJavadoc>`	`boolean`	`-`	Link the Javadoc from the Source XRef. Defaults to true and will link automatically if javadoc plugin is being used. Default value is: `true`.
`<outputEncoding>`	`String`	`-`	File output encoding. Default value is: `${project.reporting.outputEncoding}`. User property is: `outputEncoding`.
`<skip>`	`boolean`	`2.3`	Whether to skip this execution. Default value is: `false`. User property is: `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 value is: `${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: Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved.

<destDir>

Folder where the Xref files will be copied to.

Type: java.lang.String
Required: No
Default: ${project.reporting.outputDirectory}/xref

<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
Since: 2.1
Required: No

<includes>

A list of include patterns to use. By default all .java files are included.

Type: java.util.ArrayList
Since: 2.1
Required: No

<inputEncoding>

File input encoding.

Type: java.lang.String
Required: No
User Property: encoding
Default: ${project.build.sourceEncoding}

<javadocDir>

Folder where Javadoc is generated for this project.

Type: java.io.File
Required: No
Default: ${project.reporting.outputDirectory}/apidocs

<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

Output folder where the main page of the report will be generated. Note that this parameter is only relevant if the goal is run directly from the command line or from the default lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin will be used instead.

Type: java.io.File
Required: Yes
Default: ${project.reporting.outputDirectory}

<outputEncoding>

File output encoding.

Type: java.lang.String
Required: No
User Property: outputEncoding
Default: ${project.reporting.outputEncoding}

<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