|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectweka.core.Javadoc
weka.core.GlobalInfoJavadoc
public class GlobalInfoJavadoc
Generates Javadoc comments from the class's globalInfo method. Can automatically update the comments if they're surrounded by the GLOBALINFO_STARTTAG and GLOBALINFO_ENDTAG (the indention is determined via the GLOBALINFO_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.
GLOBALINFO_METHOD,
GLOBALINFO_STARTTAG,
GLOBALINFO_ENDTAG| Field Summary | |
|---|---|
static java.lang.String |
GLOBALINFO_ENDTAG
the end comment tag for inserting the generated Javadoc |
static java.lang.String |
GLOBALINFO_METHOD
the globalInfo method name |
static java.lang.String |
GLOBALINFO_STARTTAG
the start comment tag for inserting the generated Javadoc |
| Constructor Summary | |
|---|---|
GlobalInfoJavadoc()
default constructor |
|
| Method Summary | |
|---|---|
java.lang.String |
getRevision()
Returns the revision string. |
static void |
main(java.lang.String[] args)
Parses the given commandline parameters and generates the Javadoc. |
| Methods inherited from class weka.core.Javadoc |
|---|
generate, generateHelp, getClassname, getDir, getOptions, getSilent, getUseStars, listOptions, setClassname, setDir, setOptions, 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 GLOBALINFO_METHOD
public static final java.lang.String GLOBALINFO_STARTTAG
public static final java.lang.String GLOBALINFO_ENDTAG
| Constructor Detail |
|---|
public GlobalInfoJavadoc()
| Method Detail |
|---|
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 | |||||||||