sdoccode:copy

Full name:

de.smartics.exceptions:maven-sdoccode-plugin:0.6.2:copy

Description:

Extracts the exception code information of a project and generates one XML document for each code in the projectdoc's appcode doctype format.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: process-classes.

Required Parameters

Name Type Since Description
genSrcDir File 1.0 The directory containing the generated documentation XML files.

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.
codeBundleMapper String 1.0 Specifies the mapper class that allows finding the the bundle associated with a given code. The referenced class requires to implement de.smartics.messages.core.DefaultLocationBundleMapper.
Default value is: de.smartics.messages.core.DefaultLocationBundleMapper.
excludes ArrayList 1.0 Specifies the names filter of the source and class files to be excluded from the reports.
includes ArrayList 1.0 Specifies the names filter of the source and class files to be included in the reports.
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.
outputDirectory String 1.0 Specifies the root directory to write the report files to.
reportEncoding String 1.0 Specifies the encoding the reports will be written.
Default value is: UTF-8.
reportGenerator String 1.0 Specifies the name of the report generator instance. This class has to implement de.smartics.exceptions.report.ReportGenerator.
Currently one implementation is provided, which is the default.
Default value is: de.smartics.maven.exceptions.sdoccode.report.SdocCodeReportGenerator.
skip boolean 1.0 A simple flag to skip the generation of the XML files. If set on the command line use -Dsdoccode.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 Java version of the sources.
Default value is: 1.5.

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: ${sdoccode.additionalSources}

codeBundleMapper:

Specifies the mapper class that allows finding the the bundle associated with a given code. The referenced class requires to implement de.smartics.messages.core.DefaultLocationBundleMapper.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: de.smartics.messages.core.DefaultLocationBundleMapper

excludes:

Specifies the names filter of the source and class files to be excluded from the reports.
  • Type: java.util.ArrayList
  • Since: 1.0
  • Required: No
  • Expression: ${sdoccode.excludes}

genSrcDir:

The directory containing the generated documentation XML files.
  • Type: java.io.File
  • Since: 1.0
  • Required: Yes
  • Expression: ${project.build.directory}/projectdoc-work/generated/process/implementation/appproperty

includes:

Specifies the names filter of the source and class files to be included in the reports.
  • Type: java.util.ArrayList
  • Since: 1.0
  • Required: No
  • Expression: ${sdoccode.includes}

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: ${sdoccode.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: ${sdoccode.logLevel}

outputDirectory:

Specifies the root directory to write the report files to.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${project.build.directory/sdoc-export}

reportEncoding:

Specifies the encoding the reports will be written.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${project.reporting.outputEncoding}
  • Default: UTF-8

reportGenerator:

Specifies the name of the report generator instance. This class has to implement de.smartics.exceptions.report.ReportGenerator.
Currently one implementation is provided, which is the default.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${exceptioncodes.report.generator}
  • Default: de.smartics.maven.exceptions.sdoccode.report.SdocCodeReportGenerator

skip:

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

sourceEncoding:

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

sourceVersion:

Specifies the Java version of the sources.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${sdoccode.build.sourceVersion}
  • Default: 1.5