|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectweka.core.Javadoc
public abstract class Javadoc
Abstract superclass for classes that generate Javadoc comments and replace the content between certain comment tags.
| Constructor Summary | |
|---|---|
Javadoc()
|
|
| Method Summary | |
|---|---|
java.lang.String |
generate()
generates either the plain Javadoc (if no filename specified) or the updated file (if a filename is specified). |
java.lang.String |
generateHelp()
generates a string to print as help on the console |
java.lang.String |
getClassname()
returns the current classname |
java.lang.String |
getDir()
returns the current dir containing the class to update. |
java.lang.String[] |
getOptions()
Gets the current settings of this object. |
boolean |
getSilent()
whether output in the console is suppressed |
boolean |
getUseStars()
whether the Javadoc is prefixed with "*" |
java.util.Enumeration |
listOptions()
Returns an enumeration describing the available options. |
void |
setClassname(java.lang.String value)
sets the classname of the class to generate the Javadoc for |
void |
setDir(java.lang.String value)
sets the dir containing the file that is to be updated. |
void |
setOptions(java.lang.String[] options)
Parses a given list of options. |
void |
setSilent(boolean value)
sets whether to suppress output in the console |
void |
setUseStars(boolean value)
sets whether to prefix the Javadoc with "*" |
java.lang.String |
updateJavadoc()
generates the Javadoc and returns it applied to the source file if one was provided, otherwise an empty string. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface weka.core.RevisionHandler |
|---|
getRevision |
| Constructor Detail |
|---|
public Javadoc()
| Method Detail |
|---|
public java.util.Enumeration listOptions()
listOptions in interface OptionHandler
public void setOptions(java.lang.String[] options)
throws java.lang.Exception
setOptions in interface OptionHandleroptions - 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 OptionHandlerpublic void setClassname(java.lang.String value)
value - the new classnamepublic java.lang.String getClassname()
public void setUseStars(boolean value)
value - true if stars are usedpublic boolean getUseStars()
public void setDir(java.lang.String value)
value - the directory containing the classespublic java.lang.String getDir()
public void setSilent(boolean value)
value - true if output is to be suppressedpublic boolean getSilent()
public java.lang.String updateJavadoc()
throws java.lang.Exception
java.lang.Exception - in case the generation fails
public java.lang.String generate()
throws java.lang.Exception
java.lang.Exception - in case the generation failspublic java.lang.String generateHelp()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||