public class OptionHandlerJavadoc extends Javadoc
-W <classname> The class to load.
-nostars Suppresses the '*' in the Javadoc.
-dir <dir> The directory above the package hierarchy of the class.
-silent Suppresses printing in the console.
-noprolog Suppresses the 'Valid options are...' prolog in the Javadoc.
OPTIONS_STARTTAG
,
OPTIONS_ENDTAG
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
OPTIONS_ENDTAG
the end comment tag for inserting the generated Javadoc
|
static java.lang.String |
OPTIONS_STARTTAG
the start comment tag for inserting the generated Javadoc
|
Constructor and Description |
---|
OptionHandlerJavadoc()
default constructor
|
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getOptions()
Gets the current settings of this object.
|
boolean |
getProlog()
whether "Valid options are..." prolog is included in the Javadoc
|
java.lang.String |
getRevision()
Returns the revision string.
|
java.util.Enumeration |
listOptions()
Returns an enumeration describing the available options.
|
static void |
main(java.lang.String[] args)
Parses the given commandline parameters and generates the Javadoc.
|
void |
setOptions(java.lang.String[] options)
Parses a given list of options.
|
void |
setProlog(boolean value)
sets whether to add the "Valid options are..." prolog
|
generate, generateHelp, getClassname, getDir, getSilent, getUseStars, setClassname, setDir, setSilent, setUseStars, updateJavadoc
public static final java.lang.String OPTIONS_STARTTAG
public static final java.lang.String OPTIONS_ENDTAG
public java.util.Enumeration listOptions()
listOptions
in interface OptionHandler
listOptions
in class Javadoc
public void setOptions(java.lang.String[] options) throws java.lang.Exception
setOptions
in interface OptionHandler
setOptions
in class Javadoc
options
- the list of options as an array of stringsjava.lang.Exception
- if an option is not supportedpublic java.lang.String[] getOptions()
getOptions
in interface OptionHandler
getOptions
in class Javadoc
public void setProlog(boolean value)
value
- true if the prolog is to be addedpublic boolean getProlog()
public java.lang.String getRevision()
public static void main(java.lang.String[] args)
args
- the commandline parameters for the object