spf4j-jdiff:descriptor

Full name:

org.spf4j:spf4j-jdiff-maven-plugin:8.9.3-SNAPSHOT:descriptor

Description:

Generates an API descriptor of the Java sources.

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
<apiname> String - The JDiff API name.
Default value is: ${project.artifactId}-${project.version}.
<includePackageNames> ArrayList - List of packages.
User property is: includePackageNames.
<javadocExecutable> String - The javadoc executable.
User property is: javadocExecutable.

Parameter Details

<apiname>

The JDiff API name.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.artifactId}-${project.version}

<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