jdiff:jdiff
Note:This goal should be used as a Maven report.
Full name:
org.codehaus.mojo:jdiff-maven-plugin:1.0-beta-1:jdiff
Description:
Generates an API difference report between Java sources of two SCM
versions
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope: compile.
- Invokes the execution of the lifecycle phase generate-sources prior to executing itself.
Optional Parameters
| Name |
Type |
Since |
Description |
| baseVersion |
String |
- |
The base code version. This will be the right-hand side of the
report. Default value is: ${project.version}. |
| comparisonVersion |
String |
- |
Version to compare the base code against. This will be the
left-hand side of the report. Default value is: (,${project.version}). |
| description |
String |
- |
The description of the JDiff report to be displayed in the Maven
Generated Reports page (i.e. project-reports.html).
|
| destDir |
String |
- |
The name of the destination directory. Default value is: apidocs. |
| forceCheckout |
boolean |
- |
Force a checkout instead of an update when the sources have already
been checked out during a previous run. Default value is: false. |
| javadocExecutable |
String |
- |
The javadoc executable.
|
| name |
String |
- |
The name of the JDiff report to be displayed in the Maven Generated
Reports page (i.e. project-reports.html).
|
Parameter Details
baseVersion:
The base code version. This will be the right-hand side of the
report.
- Type: java.lang.String
- Required: No
- Expression: ${jdiff.baseVersion}
- Default: ${project.version}
comparisonVersion:
Version to compare the base code against. This will be the
left-hand side of the report.
- Type: java.lang.String
- Required: No
- Expression: ${jdiff.comparisonVersion}
- Default: (,${project.version})
description:
The description of the JDiff report to be displayed in the Maven
Generated Reports page (i.e. project-reports.html).
- Type: java.lang.String
- Required: No
destDir:
The name of the destination directory.
- Type: java.lang.String
- Required: No
- Expression: ${destDir}
- Default: apidocs
forceCheckout:
Force a checkout instead of an update when the sources have already
been checked out during a previous run.
- Type: boolean
- Required: No
- Expression: ${jdiff.forceCheckout}
- Default: false
javadocExecutable:
The javadoc executable.
- Type: java.lang.String
- Required: No
- Expression: ${javadocExecutable}
name:
The name of the JDiff report to be displayed in the Maven Generated
Reports page (i.e. project-reports.html).
- Type: java.lang.String
- Required: No