Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-jxr-plugin:2.2:test-jxr
Description:
Attributes:
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. |
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} . |
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} . |
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 . |
testJavadocDir | File |
- |
Folder where Test Javadoc is generated for this project. |
windowTitle | String |
- |
Title of window of the Xref HTML files. |
boolean
No
${aggregate}
false
java.lang.String
No
${bottom}
Copyright © {inceptionYear}-{currentYear} {projectOrganizationName}. All Rights Reserved.
java.lang.String
No
${project.reporting.outputDirectory}/xref-test
java.lang.String
No
${project.name} ${project.version} Reference
java.util.ArrayList
2.1
No
${excludes}
java.util.ArrayList
2.1
No
${includes}
java.lang.String
No
${encoding}
${project.build.sourceEncoding}
boolean
No
${linkJavadoc}
true
java.io.File
Yes
${project.reporting.outputDirectory}
java.lang.String
No
${outputEncoding}
${project.reporting.outputEncoding}
"${basedir}/myStyles.css"
.java.lang.String
No
stylesheet.css
"${basedir}/myTemplates"
.java.lang.String
No
templates
java.io.File
No
${project.reporting.outputDirectory}/testapidocs
java.lang.String
No
${project.name} ${project.version} Reference