eugene:tag-values-report
Note:This goal should be used as a Maven report.
Full name:
org.nuiton.eugene:eugene-maven-plugin:3.1-SNAPSHOT:tag-values-report
Description:
To report a
TagValueMetadatasProvider. Created on
5/31/14.Attributes:
- Requires a Maven project to be executed.
- Executes only as a reportSet (reporting goal).
- Requires dependency resolution of artifacts in scope:
compile. - Since version:
2.10.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<outputDirectory> |
File |
2.10 |
Report output directory. Note that this parameter is only relevant
if the goal is run from the command line or from the default build
lifecycle. If the goal is run indirectly as part of a site
generation, the output directory configured in the Maven Site
Plugin is used instead. Default value is: ${project.reporting.outputDirectory}.User property is: config.outputDirectory. |
<outputEncoding> |
String |
2.10 |
Report output encoding. Note that this parameter is only relevant
if the goal is run from the command line or from the default build
lifecycle. If the goal is run indirectly as part of a site
generation, the output encoding configured in the Maven Site Plugin
is used instead. Default value is: ${project.reporting.outputEncoding}.User property is: config.outputEncoding. |
<providerName> |
String |
2.10 |
Name of the tagValue provider. This is the role-hint given to the
tag value provider to describe. Default value is: ${project.artifactId}.User property is: eugene.providerName. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<javaDocDestDir> |
String |
2.10 |
Location of javadoc report. Default value is: apidocs.User property is: eugene.javaDocDestDir. |
<jxrDestDir> |
String |
2.10 |
Location of xref report. Default value is: xref.User property is: eugene.jxrDestDir. |
<skip> |
boolean |
2.10 |
Skip to generate the report. User property is: config.skip. |
Parameter Details
<javaDocDestDir>
Location of javadoc report.
- Type:
java.lang.String - Since:
2.10 - Required:
No - User Property:
eugene.javaDocDestDir - Default:
apidocs
<jxrDestDir>
Location of xref report.
- Type:
java.lang.String - Since:
2.10 - Required:
No - User Property:
eugene.jxrDestDir - Default:
xref
<outputDirectory>
Report output directory. Note that this parameter is only relevant
if the goal is run from the command line or from the default build
lifecycle. If the goal is run indirectly as part of a site
generation, the output directory configured in the Maven Site
Plugin is used instead.
- Type:
java.io.File - Since:
2.10 - Required:
Yes - User Property:
config.outputDirectory - Default:
${project.reporting.outputDirectory}
<outputEncoding>
Report output encoding. Note that this parameter is only relevant
if the goal is run from the command line or from the default build
lifecycle. If the goal is run indirectly as part of a site
generation, the output encoding configured in the Maven Site Plugin
is used instead.
- Type:
java.lang.String - Since:
2.10 - Required:
Yes - User Property:
config.outputEncoding - Default:
${project.reporting.outputEncoding}
<providerName>
Name of the tagValue provider. This is the role-hint given to the
tag value provider to describe.
- Type:
java.lang.String - Since:
2.10 - Required:
Yes - User Property:
eugene.providerName - Default:
${project.artifactId}
<skip>
Skip to generate the report.
- Type:
boolean - Since:
2.10 - Required:
No - User Property:
config.skip