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.
archive	MavenArchiveConfiguration	-	The archive configuration to use. See Maven Archiver Reference.
attach	boolean	1.0	Specifies whether to attach the generated artifact to the project helper. Default value is: true.
classifier	String	1.0	The classifier to use to generate the attached artifact. Default value is: sdoc_appcode.
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. The path starts at the source path root, not at the project root.
includes	ArrayList	1.0	Specifies the names filter of the source and class files to be included in the reports. The path starts at the source path root, not at the project root.
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.sdoc.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:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Expression: ${exceptioncodes.additionalSources}

---

archive:

• Type: org.apache.maven.archiver.MavenArchiveConfiguration
• Required: No

---

attach:

• Type: boolean
• Since: 1.0
• Required: No
• Expression: ${attach}
• Default: true

---

classifier:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Default: sdoc_appcode

---

codeBundleMapper:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Default: de.smartics.messages.core.DefaultLocationBundleMapper

---

excludes:

• Type: java.util.ArrayList
• Since: 1.0
• Required: No
• Expression: ${exceptioncodes.excludes}

---

includes:

• Type: java.util.ArrayList
• Since: 1.0
• Required: No
• Expression: ${exceptioncodes.includes}

---

locale:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Expression: ${exceptioncodes.locale}

---

logLevel:

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

---

outputDirectory:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Expression: ${project.build.directory}/sdoc-export

---

reportEncoding:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Expression: ${project.reporting.outputEncoding}
• Default: UTF-8

---

reportGenerator:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Expression: ${exceptioncodes.report.generator}
• Default: de.smartics.maven.exceptions.sdoc.SdocCodeReportGenerator

---

skip:

• Type: boolean
• Since: 1.0
• Required: No
• Expression: ${sdoccode.skip}
• Default: false

---

sourceEncoding:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Expression: ${project.build.sourceEncoding}
• Default: UTF-8

---

sourceVersion:

• Type: java.lang.String
• Since: 1.0
• Required: No
• Expression: ${exceptioncodes.build.sourceVersion}
• Default: 1.5