Required Parameters

Name	Type	Description
outputDirectory	String	Output folder where the main page of the report will be generated.

Optional Parameters

Name	Type	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} ${project.organization.name}. 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.
inputEncoding	String	File input encoding. Default value is ISO-8859-1.
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 ISO-8859-1.
siteRenderer	Renderer	No description.
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} ${project.organization.name}. 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

---

inputEncoding

File input encoding.

• Type: java.lang.String
• Required: No
• Default: ISO-8859-1

---

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.

• Type: java.lang.String
• Required: Yes
• Expression: ${project.reporting.outputDirectory}

---

outputEncoding

File output encoding.

• Type: java.lang.String
• Required: No
• Default: ISO-8859-1

---

siteRenderer

No Description.

• Type: org.apache.maven.doxia.siterenderer.Renderer
• 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
• 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