README.adoc

JAX-RS Analyzer Maven Plugin

Maven plugin for the JAX-RS Documentation.

To enable the plugin, simply add these lines to your pom.xml in the <plugins> section.

<plugin>
  <groupId>com.github.mibo</groupId>
  <artifactId>jaxrs-doc-maven-plugin</artifactId>
  <version>1.0.0</version>
  <executions>
    <execution>
      <goals>
        <goal>generate-doc</goal>
      </goals>
      <configuration>
        <backend>swagger,asciidoc</backend>
        <deployedDomain>example.com</deployedDomain>
      </configuration>
    </execution>
  </executions>
</plugin>

After building your project, the documentation resides under 'target/jaxrs-doc/'.

For all configuration options please see documentation.