apidoc:apidoc-report

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

Full name:

de.smartics.maven.plugin:maven-apidoc-plugin:0.1.5:apidoc-report

Description:

API doc report.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: site.

Optional Parameters

Name Type Since Description
additionalSources String 1.0 Specifies additional root directories of source files to consider. Please note that source file archives found at the same location as the class file archives are automatically visible. The source archive is required to have the suffix -sources in front of the extension and only jar- and zip-archives are supported.
additionalparam String 1.0 Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces.
doclet String 1.0 The doclet to use to listen to errors, warnings and issues.
Default value is: com.sun.tools.doclets.standard.Standard.
excludes String 1.0 Specifies the names filter of the source and class files to be excluded from the report.
includes String 1.0 Specifies the names filter of the source and class files to be included in the report.
Default value is: **.
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.
logLevel String 1.0 Specifies the log level used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.
noticeMessagesRendered boolean 1.0 The flag that indicates if notice messages should be rendered in the report (true) or if only error and warn messages are rendered ( false).
Default value is: false.
reportSetId String 1.0 The report set to watch for additional parameters. This is useful if you want to include the additional parameters of the maven-javadoc-plugin to be used in this analysis. Please note that only those additionalparam elements are used that provide an id that starts with the character sequence "apidoc".
Default value is: default.
skip boolean 1.0 A simple flag to skip the generation of the reports. If set on the command line use -Dapidoc.skip.
Default value is: false.
sourceEncoding String 1.0 Specifies the encoding the sources will be read.
Default value is: UTF-8.
sourceVersion String 1.0 Specifies the encoding the sources will be read.
Default value is: 1.5.
xrefLocation String 1.0 The location the XRef report is rendered to, relative to the site directory.
Default value is: xref.

Parameter Details

additionalSources:

Specifies additional root directories of source files to consider. Please note that source file archives found at the same location as the class file archives are automatically visible. The source archive is required to have the suffix -sources in front of the extension and only jar- and zip-archives are supported.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${apidoc.additionalSources}

additionalparam:

Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${apidoc.additionalparam}

doclet:

The doclet to use to listen to errors, warnings and issues.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: com.sun.tools.doclets.standard.Standard

excludes:

Specifies the names filter of the source and class files to be excluded from the report.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${apidoc.excludes}

includes:

Specifies the names filter of the source and class files to be included in the report.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${apidoc.includes}
  • Default: **

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
  • Expression: ${apidoc.locale}

logLevel:

Specifies the log level used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${apidoc.logLevel}

noticeMessagesRendered:

The flag that indicates if notice messages should be rendered in the report ( true) or if only error and warn messages are rendered ( false).
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

reportSetId:

The report set to watch for additional parameters. This is useful if you want to include the additional parameters of the maven-javadoc-plugin to be used in this analysis. Please note that only those additionalparam elements are used that provide an id that starts with the character sequence " apidoc".
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: default

skip:

A simple flag to skip the generation of the reports. If set on the command line use -Dapidoc.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${apidoc.skip}
  • Default: false

sourceEncoding:

Specifies the encoding the sources will be read.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${apidoc.build.sourceEncoding}
  • Default: UTF-8

sourceVersion:

Specifies the encoding the sources will be read.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${apidoc.build.sourceVersion}
  • Default: 1.5

xrefLocation:

The location the XRef report is rendered to, relative to the site directory.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: xref