Package org.forgerock.opendj.maven.doc

Class GenerateRefEntriesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.forgerock.opendj.maven.doc.GenerateRefEntriesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate-refentry",
      defaultPhase=PREPARE_PACKAGE,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME)
public final class GenerateRefEntriesMojo
extends org.apache.maven.plugin.AbstractMojo

Generate DocBook RefEntry source documents for command-line tools man pages.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenerateRefEntriesMojo.Mode	Represents the execution mode of this plugin.

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateRefEntriesMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Writes a RefEntry file to the output directory for each tool.

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

GenerateRefEntriesMojo

public GenerateRefEntriesMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Writes a RefEntry file to the output directory for each tool. Files names correspond to script names: man-<name>.xml.

Throws:

org.apache.maven.plugin.MojoExecutionException - Encountered a problem writing a file.

org.apache.maven.plugin.MojoFailureException - Failed to initialize effectively, or to write one or more RefEntry files.