Built by Maven

jxr:aggregate

Note:

This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-jxr-plugin:3.3.2:aggregate

Description:

Generates a combined JXR report in an aggregating project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.3.
  • Invokes the execution of the following lifecycle phase prior to executing itself: compile.

Optional Parameters

Name Type Since Description
<bottom> String - String used at the bottom of the Xref HTML files.
Default: Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved.
User Property: bottom
<destDir> String - Directory where the Xref files will be copied to.
Default: ${project.reporting.outputDirectory}/xref
<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.
<javadocDir> File - Directory where Javadoc is generated for this project.
Default: ${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: 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
<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: report.plugin.goal.no
  • User Property: bottom
  • Default: Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved.

<destDir>

Directory where the Xref files will be copied to.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • Default: ${project.reporting.outputDirectory}/xref

<docTitle>

Title of main page of the Xref HTML files.
  • Type: java.lang.String
  • Required: report.plugin.goal.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: report.plugin.goal.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: report.plugin.goal.no

<javadocDir>

Directory where Javadoc is generated for this project.
  • Type: java.io.File
  • Required: report.plugin.goal.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: report.plugin.goal.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: report.plugin.goal.no
  • Default: true

<skip>

Whether to skip this execution.
  • Type: boolean
  • Since: 2.3
  • Required: report.plugin.goal.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: report.plugin.goal.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: report.plugin.goal.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: report.plugin.goal.no

<windowTitle>

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