smartics-properties:properties-report

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

Full name:

de.smartics.properties:smartics-properties-maven-plugin:0.2.0:properties-report

Description:

A site report on all property sets of the project. A index refers to the property sets that refer to the individual properties.

Attributes:

  • Requires a Maven project to be executed.
  • Executes only as a reportSet (reporting goal).
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 1.0.

Optional Parameters

Name Type Since Description
addMain boolean 1.0 Adds the main sources to the list of reports.
Default value is: true.
addTest boolean 1.0 Adds the test sources to the list of reports.
Default value is: false.
aggregate boolean 1.0 The flag to control the aggregation of reports. If set to true the report will be aggregated in the multi module POM. Otherwise it is generated for each sub module individually.
Default value is: false.
encoding String 1.0 The encoding of the source files.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
javadocLocation File 1.0 The location of the Javadoc report to reference.
Default value is: ${project.reporting.outputDirectory}/apidocs.
linkJavadoc boolean 1.0 Controls whether to reference the Javadoc report when found.
Default value is: true.
User property is: linkJavadoc.
linkXref boolean 1.0 Controls whether to reference the source code report (XRef) when found.
Default value is: true.
User property is: linkXRef.
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.
skip boolean 1.0 A simple flag to skip the generation of the reports. If set on the command line use -Dsmartics-properties.skip.
Default value is: false.
User property is: smartics-properties.skip.
xrefLocation File 1.0 The location of the source code report (XRef) to reference.
Default value is: ${project.reporting.outputDirectory}/xref.

Parameter Details

addMain:

Adds the main sources to the list of reports.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

addTest:

Adds the test sources to the list of reports.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

aggregate:

The flag to control the aggregation of reports. If set to true the report will be aggregated in the multi module POM. Otherwise it is generated for each sub module individually.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

encoding:

The encoding of the source files.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

javadocLocation:

The location of the Javadoc report to reference.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.reporting.outputDirectory}/apidocs

linkJavadoc:

Controls whether to reference the Javadoc report when found.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: linkJavadoc
  • Default: true

linkXref:

Controls whether to reference the source code report (XRef) when found.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: linkXRef
  • Default: true

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

skip:

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

xrefLocation:

The location of the source code report (XRef) to reference.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.reporting.outputDirectory}/xref