Plugin Documentation

Goals available for this plugin:

Goal Report? Description
servicedocgen:generate Yes 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
servicedocgen:help No Display help information on servicedocgen-maven-plugin.
Call mvn servicedocgen:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.0
JDK 1.6
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.codehaus.mojo</groupId>
          <artifactId>servicedocgen-maven-plugin</artifactId>
          <version>1.0.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>servicedocgen-maven-plugin</artifactId>
        <version>1.0.0</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>servicedocgen-maven-plugin</artifactId>
        <version>1.0.0</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"