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	-	Deprecated. since 2.3. Use the goals jxr:aggregate and jxr:test-aggregate instead. Default value is: false.
bottom	String	-	String used at the bottom of the Xref HTML files. Default value is: Copyright © {inceptionYear}–{currentYear} {organizationName}. 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}.
skip	boolean	2.3	Whether to skip this execution. Default value is: false.
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:

• Type: boolean
• Required: No
• Expression: ${aggregate}
• Default: false

---

bottom:

• Type: java.lang.String
• Required: No
• Expression: ${bottom}
• Default: Copyright © {inceptionYear}–{currentYear} {organizationName}. All rights reserved.

---

destDir:

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

---

docTitle:

• Type: java.lang.String
• Required: No
• Expression: ${project.name} ${project.version} Reference

---

excludes:

• Type: java.util.ArrayList
• Since: 2.1
• Required: No
• Expression: ${excludes}

---

includes:

• Type: java.util.ArrayList
• Since: 2.1
• Required: No
• Expression: ${includes}

---

inputEncoding:

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

---

javadocDir:

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

---

linkJavadoc:

• Type: boolean
• Required: No
• Expression: ${linkJavadoc}
• Default: true

---

outputDirectory:

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

---

outputEncoding:

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

---

skip:

• Type: boolean
• Since: 2.3
• Required: No
• Expression: ${maven.jxr.skip}
• Default: false

---

sourcePath:

• Type: java.lang.String
• Required: No
• Expression: ${sourcePath}

---

stylesheet:

• Type: java.lang.String
• Required: No
• Default: stylesheet.css

---

templateDir:

• Type: java.lang.String
• Required: No
• Default: templates

---

windowTitle:

• Type: java.lang.String
• Required: No
• Expression: ${project.name} ${project.version} Reference