alias:alias-report

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

Full name:

de.smartics.maven.plugin:alias-maven-plugin:0.3.4:alias-report

Description:

Generates a report about the aliases defined in this project.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: site.

Required Parameters

Name Type Since Description
aliasLocation String 1.0 The location of the alias definitions. The contents of the file is required to use the alias XSD.
Default value is: ${basedir}/src/main/resources/alias.xml.

Optional Parameters

Name Type Since Description
locale String 1.0 The locale to use regardless of the report. This should be set to the locale the Javadoc comment is written in. If not set, the Maven provided locale is used.
User property is: locale.
skip boolean 1.0 A simple flag to skip the generation of the reports. If set on the command line use -Dalias.skip.
Default value is: false.
User property is: alias.skip.

Parameter Details

aliasLocation:

The location of the alias definitions. The contents of the file is required to use the alias XSD.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Default: ${basedir}/src/main/resources/alias.xml

locale:

The locale to use regardless of the report. This should be set to the locale the Javadoc comment is written in. If not set, the Maven provided locale is used.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: locale

skip:

A simple flag to skip the generation of the reports. If set on the command line use -Dalias.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: alias.skip
  • Default: false