/servicedocgen-maven-plugin

ServicedocGen Maven Plugin

Primary LanguageJavaApache License 2.0Apache-2.0

MojoHaus ServicedocGen Maven Plugin

This is the servicedocgen-maven-plugin.

Build Status

Quickstart

This plugin automatically generates a nice documentation for your REST-Services from JAX-RS annotated classes or interfaces.

  <build>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>servicedocgen-maven-plugin</artifactId>
        <!--<version>INSERT LATEST VERSION HERE</version>-->
        <executions>
          <execution>
            <goals>
              <goal>generate</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <!-- See usage on maven site from link above for details -->
        </configuration>
      </plugin>
    </plugins>
  </build>

Releasing

  • Make sure gpg-agent is running.
  • Execute mvn -B release:prepare release:perform

For publishing the site do the following:

cd target/checkout
mvn verify site site:stage scm-publish:publish-scm