|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectweka.core.Javadoc
weka.core.OptionHandlerJavadoc
public class OptionHandlerJavadoc
Generates Javadoc comments from the OptionHandler's options. Can automatically update the option comments if they're surrounded by the OPTIONS_STARTTAG and OPTIONS_ENDTAG (the indention is determined via the OPTIONS_STARTTAG).
Valid options are:-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| Field Summary | |
|---|---|
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 Summary | |
|---|---|
OptionHandlerJavadoc()
default constructor |
|
| Method Summary | |
|---|---|
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 |
| Methods inherited from class weka.core.Javadoc |
|---|
generate, generateHelp, getClassname, getDir, getSilent, getUseStars, setClassname, setDir, setSilent, setUseStars, updateJavadoc |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String OPTIONS_STARTTAG
public static final java.lang.String OPTIONS_ENDTAG
| Constructor Detail |
|---|
public OptionHandlerJavadoc()
| Method Detail |
|---|
public java.util.Enumeration listOptions()
listOptions in interface OptionHandlerlistOptions in class Javadoc
public void setOptions(java.lang.String[] options)
throws java.lang.Exception
setOptions in interface OptionHandlersetOptions in class Javadocoptions - the list of options as an array of strings
java.lang.Exception - if an option is not supportedpublic java.lang.String[] getOptions()
getOptions in interface OptionHandlergetOptions in class Javadocpublic 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
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||