GenerateResultCodeDocMojo (OpenDJ Doc Helper Maven Plugin 4.5.3 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.forgerock.opendj.maven.doc.GenerateResultCodeDocMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="generate-result-code-doc",
      defaultPhase=COMPILE)
public class GenerateResultCodeDocMojo
extends org.apache.maven.plugin.AbstractMojo
```
Generates documentation source for LDAP result codes based on org.forgerock.opendj.ldap.ResultCode.
This implementation parses the source to match Javadoc comments with result codes. It is assumed that the class's ResultCode fields are named with result code enum values, and that those fields have Javadoc comments describing each result code.

- Field Summary
  - Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
- Constructor Summary
  
  Constructors
  Constructor Description
  
  GenerateResultCodeDocMojo()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  void execute()
  Generates documentation source for LDAP result codes.
  - Methods inherited from class org.apache.maven.plugin.AbstractMojo
    getLog, getPluginContext, setLog, setPluginContext
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GenerateResultCodeDocMojo
```
public GenerateResultCodeDocMojo()
```
- Method Detail
  - execute
```
public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
```
    Generates documentation source for LDAP result codes.
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - Generation failed
    
    org.apache.maven.plugin.MojoFailureException - Not used