Package adams.doc.javadoc

Class AllJavadoc

java.lang.Object

adams.core.logging.LoggingObject

adams.doc.javadoc.Javadoc

adams.doc.javadoc.AllJavadoc

All Implemented Interfaces:

Destroyable, LoggingSupporter, OptionHandler, UserModeSupporter, SizeOfHandler, Serializable

public class AllJavadoc
extends Javadoc

Applies all known Javadoc-derived classes to a source file. 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.
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List	m_Javadocs	contains all the javadoc generators.

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
AllJavadoc()

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.
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.

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, setDir, setEnvironment, setUserMode, silentTipText, toCommandLine, toHTML, toString, 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

m_Javadocs

protected List m_Javadocs

contains all the javadoc generators.

Constructor Detail

AllJavadoc

public AllJavadoc()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class Javadoc

setClassname

public void setClassname(String value)

sets the classname of the class to generate the Javadoc for.

Overrides:

setClassname in class Javadoc

Parameters:

value - the new classname

setUseStars

public void setUseStars(boolean value)

sets whether to prefix the Javadoc with "*".

Overrides:

setUseStars in class Javadoc

Parameters:

value - true if stars are to be used

setSilent

public void setSilent(boolean value)

sets whether to suppress output in the console.

Overrides:

setSilent in class Javadoc

Parameters:

value - true if output is to be suppressed

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

updateJavadoc

protected String updateJavadoc(String content)
                        throws Exception

updates the Javadoc in the given source code, using all the found Javadoc updaters.

Overrides:

updateJavadoc in class Javadoc

Parameters:

content - the source code

Returns:

the updated source code

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