public class GlobalInfoJavadoc 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.
GLOBALINFO_METHOD
,
GLOBALINFO_STARTTAG
,
GLOBALINFO_ENDTAG
Modifier and Type | Field and Description |
---|---|
static String |
GLOBALINFO_ENDTAG
the end comment tag for inserting the generated Javadoc
|
static String |
GLOBALINFO_METHOD
the globalInfo method name
|
static String |
GLOBALINFO_STARTTAG
the start comment tag for inserting the generated Javadoc
|
m_Classname, m_Dir, m_EndTag, m_Silent, m_StartTag, m_UseStars
Constructor and Description |
---|
GlobalInfoJavadoc()
default constructor
|
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.
|
canInstantiateClass, generate, generateHelp, generateJavadoc, getClassname, getDir, getIndentionLength, getIndentionString, getInstance, getOptions, getSilent, getUseStars, indent, listOptions, println, runJavadoc, setClassname, setDir, setOptions, setSilent, setUseStars, toHTML, updateJavadoc, updateJavadoc, updateJavadoc
public static final String GLOBALINFO_METHOD
public static final String GLOBALINFO_STARTTAG
public static final String GLOBALINFO_ENDTAG
protected String generateJavadoc(int index) throws Exception
generateJavadoc
in class Javadoc
index
- the index in the start/end tag arrayException
- 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.