public class AllJavadoc 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.
Modifier and Type | Field and Description |
---|---|
protected static Vector |
m_Javadocs
contains all the
|
m_Classname, m_Dir, m_EndTag, m_Silent, m_StartTag, m_UseStars
Constructor and Description |
---|
AllJavadoc() |
Modifier and Type | Method and Description |
---|---|
protected String |
generateJavadoc(int index)
generates and returns the Javadoc for the specified start/end tag pair.
|
String |
getRevision()
Returns the revision string.
|
static void |
main(String[] args)
Parses the given commandline parameters and generates the Javadoc.
|
void |
setClassname(String value)
sets the classname of the class to generate the Javadoc for
|
void |
setSilent(boolean value)
sets whether to suppress output in the console
|
void |
setUseStars(boolean value)
sets whether to prefix the Javadoc with "*"
|
protected String |
updateJavadoc(String content)
updates the Javadoc in the given source code, using all the found
Javadoc updaters.
|
canInstantiateClass, generate, generateHelp, generateJavadoc, getClassname, getDir, getIndentionLength, getIndentionString, getInstance, getOptions, getSilent, getUseStars, indent, listOptions, println, runJavadoc, setDir, setOptions, toHTML, updateJavadoc, updateJavadoc
protected static Vector m_Javadocs
public void setClassname(String value)
setClassname
in class Javadoc
value
- the new classnamepublic void setUseStars(boolean value)
setUseStars
in class Javadoc
value
- true if stars are to be usedpublic void setSilent(boolean value)
protected String generateJavadoc(int index) throws Exception
generateJavadoc
in class Javadoc
index
- the index in the start/end tag arrayException
- in case the generation failsprotected String updateJavadoc(String content) throws Exception
updateJavadoc
in class Javadoc
content
- the source codeException
- in case the generation failspublic String getRevision()
public static void main(String[] args)
args
- the commandline parameters for the objectCopyright © 2015 University of Waikato, Hamilton, NZ. All rights reserved.