spf4j-jdiff:jdiff

Note:This goal should be used as a Maven report.

Full name:

org.spf4j:spf4j-jdiff-maven-plugin:8.9.3-SNAPSHOT: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 verify prior to executing itself.

Optional Parameters

Name Type Since Description
<destDir> File - The name of the destination directory.
Default value is: ${project.reporting.outputDirectory}/apidocs.
User property is: destDir.
<includePackageNames> ArrayList - List of packages.
User property is: includePackageNames.
<javadocExecutable> String - The javadoc executable.
User property is: javadocExecutable.
<maxNumberOfDiffs> int - The name of the destination directory.
Default value is: 10.
User property is: maxNumberOfDiffs.
<versionRange> String - The version range to compute diff for. THis is a standard maven version range like [v1,v2], etc
Default value is: [,${project.version}].
User property is: versionRange.

Parameter Details

<destDir>

The name of the destination directory.
  • Type: java.io.File
  • Required: No
  • User Property: destDir
  • Default: ${project.reporting.outputDirectory}/apidocs

<includePackageNames>

List of packages.
  • Type: java.util.ArrayList
  • Required: No
  • User Property: includePackageNames

<javadocExecutable>

The javadoc executable.
  • Type: java.lang.String
  • Required: No
  • User Property: javadocExecutable

<maxNumberOfDiffs>

The name of the destination directory.
  • Type: int
  • Required: No
  • User Property: maxNumberOfDiffs
  • Default: 10

<versionRange>

The version range to compute diff for. THis is a standard maven version range like [v1,v2], etc
  • Type: java.lang.String
  • Required: No
  • User Property: versionRange
  • Default: [,${project.version}]