servicedocgen:generate

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

Full name:

org.codehaus.mojo:servicedocgen-maven-plugin:1.0.0:generate

Description:

AbstractMojo Maven Plugin to automatically generate documentation for services of the current project.
  1. Scans the current projects source code for (JAX-RS annotated) services that match the RegEx configured by classnameRegex.
  2. Analyzes the services from source-code (extract JavaDoc, etc.) and byte-code (resolve generic parameters, etc.) and create intermediate meta-data as ServicesDescriptor.
  3. Generates documentation from the collected meta-data (by default as HTML from a velocity template shipped with this plugin but can be overridden via configuration parameters).
scan and analyze services from the current project via source-code and byte-code analysis. Creates

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile+runtime.
  • Binds by default to the lifecycle phase: prepare-package.

Optional Parameters

Name Type Since Description
<classnameRegex> String - The regex Pattern that service classes have to match.
Default value is: .*Service.*.
<descriptor> ServicesDescriptor - (no description)
<introspectFields> boolean - Set to true if you want to introspect fields of Java beans and false for getters.
Default value is: false.
<reportFolder> String - The directory where the generated service documentation will be written to.
Default value is: servicedoc.
<serviceClassName> String - The fully qualified classname of the service to generate. Empty for auto-discovery (default).
<sourceEncoding> String - (no description)
Default value is: ${project.build.sourceEncoding}.
<templatePath> String - (no description)
Default value is: org/codehaus/mojo/servicedocgen/generation/velocity.
<templates> List - (no description)

Parameter Details

<classnameRegex>

The regex Pattern that service classes have to match.
  • Type: java.lang.String
  • Required: No
  • Default: .*Service.*

<descriptor>

(no description)
  • Type: org.codehaus.mojo.servicedocgen.descriptor.ServicesDescriptor
  • Required: No

<introspectFields>

Set to true if you want to introspect fields of Java beans and false for getters.
  • Type: boolean
  • Required: No
  • Default: false

<reportFolder>

The directory where the generated service documentation will be written to.
  • Type: java.lang.String
  • Required: No
  • Default: servicedoc

<serviceClassName>

The fully qualified classname of the service to generate. Empty for auto-discovery (default).
  • Type: java.lang.String
  • Required: No

<sourceEncoding>

(no description)
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<templatePath>

(no description)
  • Type: java.lang.String
  • Required: No
  • Default: org/codehaus/mojo/servicedocgen/generation/velocity

<templates>

(no description)
  • Type: java.util.List
  • Required: No