jxr:jxr

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

Full name:

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

Description:

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

Attributes:

  • Requires a Maven 2.0 project to be executed.

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.

Optional Parameters

Name Type Since Description
aggregate boolean - Whether to build an aggregated report at the root, or build individual reports.
Default value is: false.
bottom String - String uses at the bottom of the Xref HTML files.
Default value is: Copyright © {inceptionYear}-{currentYear} {projectOrganizationName}. All Rights Reserved..
destDir String - Folder where the Xref files will be copied to.
docTitle String - Title of main page of the Xref HTML files.
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}.
javadocDir File - Folder where Javadoc is generated for this project.
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}.
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".
Default value is: stylesheet.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".
Default value is: templates.
windowTitle String - Title of window of the Xref HTML files.

Parameter Details

aggregate:

Whether to build an aggregated report at the root, or build individual reports.
  • Type: boolean
  • Required: No
  • Expression: ${aggregate}
  • Default: false

bottom:

String uses at the bottom of the Xref HTML files.
  • Type: java.lang.String
  • Required: No
  • Expression: ${bottom}
  • Default: Copyright © {inceptionYear}-{currentYear} {projectOrganizationName}. All Rights Reserved.

destDir:

Folder where the Xref files will be copied to.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.reporting.outputDirectory}/xref

docTitle:

Title of main page of the Xref HTML files.
  • Type: java.lang.String
  • Required: No
  • Expression: ${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
  • Expression: ${excludes}

includes:

A list of include patterns to use. By default all .java files are included.
  • Type: java.util.ArrayList
  • Since: 2.1
  • Required: No
  • Expression: ${includes}

inputEncoding:

File input encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

javadocDir:

Folder where Javadoc is generated for this project.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.reporting.outputDirectory}/apidocs

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
  • Expression: ${linkJavadoc}
  • Default: true

outputDirectory:

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
  • Expression: ${project.reporting.outputDirectory}

outputEncoding:

File output encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${outputEncoding}
  • Default: ${project.reporting.outputEncoding}

sourcePath:

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

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
  • Default: stylesheet.css

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
  • Default: templates

windowTitle:

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