Export

Add the plugin configuration to the plugins section of your pom.xml to export the SDoc documents to a JAR (and attach it as an artifact with the standard classifier).

<plugin>
  <groupId>de.smartics.exceptions</groupId>
  <artifactId>exceptioncodes-maven-plugin</artifactId>
  <version>0.10.0</version>
  <executions>
    <execution>
      <id>sdoccode</id>
      <goals>
        <goal>export</goal>
      </goals>
      <phase>package</phase>
    </execution>
  </executions>
</plugin>

Exporting is useful if this documentation is about to be included in the documentation site of another project or if the exported information is processed to generate other artifacts.

You may add the archive element to the configuration to control the content of the manifest file. Please refer to the Manifest customization documentation of the maven-jar-plugin for details on this configuration element.

Copy

Add the plugin configuration to the plugins section of your pom.xml to copy the SDoc documents to the generated folder of your projectdoc documentation

<plugin>
  <groupId>de.smartics.exceptions</groupId>
  <artifactId>exceptioncodes-maven-plugin</artifactId>
  <version>0.10.0</version>
  <executions>
    <execution>
      <id>sdoccode</id>
      <goals>
        <goal>copy</goal>
      </goals>
      <phase>package</phase>
    </execution>
  </executions>
</plugin>

Copying is useful if the generated documentation is to be used within the project itself.

If you change the phase of the Mojo to be bound to: Please note that the generation of documentation relies on classes being compiled and added to the class path. This is normally no concern with the export plugin, but make sure for the copy plugin to be bound to a phase after 'compile'.

Adding Information

Please refer to Javadoc Tags documentation how to add additional information about codes in the Javadoc documentation.