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.0:aggregate

Description:

Generates a combined JXR report in an aggregating project.

Attributes:

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

Optional Parameters

Name Type Since Description
<bottom> String 2.3 String used at the bottom of the Xref HTML files.
Default value is: Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved..
User property is: bottom.
<destDir> String 2.3 Folder where the Xref files will be copied to.
Default value is: ${project.reporting.outputDirectory}/xref.
<docTitle> String 2.3 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.
<javadocDir> File 2.3 Folder where Javadoc is generated for this project.
Default value is: ${project.reporting.outputDirectory}/apidocs.
<javadocVersion> String 2.3 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 2.3 Link the Javadoc from the Source XRef. Defaults to true and will link automatically if javadoc plugin is being used.
Default value is: true.
<skip> boolean 2.3 Whether to skip this execution.
Default value is: false.
User property is: maven.jxr.skip.
<sourcePath> String 2.3 Specifies the source path where the java files are located. The paths are separated by ';'.
<stylesheet> String 2.3 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 2.3 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 2.3 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
  • Since: 2.3
  • Required: No
  • User Property: bottom
  • Default: Copyright &#169; {inceptionYear}&#x2013;{currentYear} {organizationName}. All rights reserved.

<destDir>

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

<docTitle>

Title of main page of the Xref HTML files.
  • Type: java.lang.String
  • Since: 2.3
  • 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

<javadocDir>

Folder where Javadoc is generated for this project.
  • Type: java.io.File
  • Since: 2.3
  • 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
  • Since: 2.3
  • 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
  • Since: 2.3
  • Required: No
  • Default: true

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

<windowTitle>

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