public class CommandLineTool extends Object
GenerateRefEntriesMojo.
| Constructor and Description |
|---|
CommandLineTool() |
| Modifier and Type | Method and Description |
|---|---|
String |
getApplication()
Returns the tool class.
|
String |
getName()
Returns the script name.
|
List<String> |
getTrailingSectionPaths()
Returns additional paths to DocBook XML
RefSect1 documents
to be appended after generated content in reference documentation. |
boolean |
isEnabled()
Returns true if the tool is enabled.
|
void |
setApplication(String application)
Set the tool class.
|
void |
setEnabled(boolean enabled)
Set to true if the tool is enabled, false otherwise.
|
void |
setName(String name)
Set the script name.
|
void |
setTrailingSectionPaths(List<String> paths)
Set additional paths to DocBook XML
RefSect1 documents. |
public CommandLineTool()
public String getApplication()
public void setApplication(String application)
application - The tool class.public List<String> getTrailingSectionPaths()
RefSect1 documents
to be appended after generated content in reference documentation.
RefEntry.
See refentry.
RefEntry describing an OpenDJ tool contains
block elements in the following order:
RefMeta
RefNameDiv
RefSynopsisDiv
RefSect1 - Description (generated, potentially with a hand-written supplement)
RefSect1 - Options (generated)
RefSect1 - Subcommands (optional, hand-written intro + generated RefSect2s)
RefSect1 - Filter (optional, hand-written)
RefSect1 - Attribute (optional, hand-written)
RefSect1 - Exit Codes (hand-written)
RefSect1 - Files (optional, hand-written)
RefSect1 - Examples (hand-written)
RefSect1 - See Also (hand-written)
As the trailing RefSect1s following Subcommands are hand-written,
they are included in the generated content as XIncludes elements.
The paths in this case are therefore relative to the current RefEntry.public void setTrailingSectionPaths(List<String> paths)
RefSect1 documents.paths - The paths relative to the current RefEntry.public boolean isEnabled()
public void setEnabled(boolean enabled)
enabled - true if the tool is enabled, false otherwise.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.