Package adams.doc.javadoc

Class GlobalInfoJavadoc

java.lang.Object

adams.core.logging.LoggingObject

adams.doc.javadoc.Javadoc

adams.doc.javadoc.GlobalInfoJavadoc

All Implemented Interfaces:

Destroyable, LoggingSupporter, OptionHandler, UserModeSupporter, SizeOfHandler, Serializable

public class GlobalInfoJavadoc
extends Javadoc

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:

-env <java.lang.String> (property: environment)
         The class to use for determining the environment.
         default: adams.core.Environment
 

-W <java.lang.String> (property: classname)
         The class to load.
         default: adams.doc.AllJavadoc
 

-nostars (property: useStars)
         Controls the use of '*' in the Javadoc.
 

-dir <java.lang.String> (property: dir)
         The directory above the package hierarchy of the class.
         default: .
 

-silent (property: silent)
         Suppresses printing in the console.
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

GLOBALINFO_METHOD, GLOBALINFO_STARTTAG, GLOBALINFO_ENDTAG, GlobalInfoJavadoc, Serialized Form

Field Summary

Fields

Modifier and Type	Field	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.

Fields inherited from class adams.doc.javadoc.Javadoc

m_Classname, m_Dir, m_EndTag, m_Environment, m_IsBlock, m_OptionManager, m_Silent, m_StartTag, m_UserMode, m_UseStars

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
GlobalInfoJavadoc()

Method Summary

Modifier and Type	Method	Description
protected String	generateJavadoc(int index)	generates and returns the Javadoc for the specified start/end tag pair.
protected void	initialize()	Initializes the members.
static void	main(String[] args)	Parses the given commandline parameters and generates the Javadoc.

Methods inherited from class adams.doc.javadoc.Javadoc

canInstantiateClass, classnameTipText, cleanUpOptions, defineOptions, destroy, dirTipText, environmentTipText, forCommandLine, forName, generate, generateJavadoc, getClassname, getDir, getEnvironment, getIndentionLength, getIndentionString, getInstance, getJavadocs, getOptionManager, getSilent, getUserMode, getUseStars, indent, newOptionManager, println, runJavadoc, setClassname, setDir, setEnvironment, setSilent, setUserMode, setUseStars, silentTipText, toCommandLine, toHTML, toString, updateJavadoc, updateJavadoc, updateJavadoc, userModeTipText, useStarsTipText

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GLOBALINFO_METHOD

public static final String GLOBALINFO_METHOD

the globalInfo method name.

See Also:

Constant Field Values

GLOBALINFO_STARTTAG

public static final String GLOBALINFO_STARTTAG

the start comment tag for inserting the generated Javadoc.

See Also:

Constant Field Values

GLOBALINFO_ENDTAG

public static final String GLOBALINFO_ENDTAG

the end comment tag for inserting the generated Javadoc.

See Also:

Constant Field Values

Constructor Detail

GlobalInfoJavadoc

public GlobalInfoJavadoc()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class Javadoc

generateJavadoc

protected String generateJavadoc(int index)
                          throws Exception

generates and returns the Javadoc for the specified start/end tag pair.

Specified by:

generateJavadoc in class Javadoc

Parameters:

index - the index in the start/end tag array

Returns:

the generated Javadoc

Throws:

Exception - in case the generation fails

main

public static void main(String[] args)

Parses the given commandline parameters and generates the Javadoc.

Parameters:

args - the commandline parameters for the object