weka.core

Class GlobalInfoJavadoc

java.lang.Object

weka.core.Javadoc

weka.core.GlobalInfoJavadoc

All Implemented Interfaces:

OptionHandler, RevisionHandler

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:

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

See Also:

GLOBALINFO_METHOD, GLOBALINFO_STARTTAG, GLOBALINFO_ENDTAG

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GLOBALINFO_ENDTAG the end comment tag for inserting the generated Javadoc
static java.lang.String	GLOBALINFO_METHOD the globalInfo method name
static java.lang.String	GLOBALINFO_STARTTAG the start comment tag for inserting the generated Javadoc

Fields inherited from class weka.core.Javadoc

m_Classname, m_Dir, m_EndTag, m_Silent, m_StartTag, m_UseStars

Constructor Summary

Constructors

Constructor and Description
GlobalInfoJavadoc() default constructor

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	generateJavadoc(int index) generates and returns the Javadoc for the specified start/end tag pair.
java.lang.String	getRevision() Returns the revision string.
static void	main(java.lang.String[] args) Parses the given commandline parameters and generates the Javadoc.

Methods inherited from class weka.core.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

Methods inherited from class java.lang.Object

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

Field Detail

GLOBALINFO_METHOD

public static final java.lang.String GLOBALINFO_METHOD

the globalInfo method name

See Also:

Constant Field Values

GLOBALINFO_STARTTAG

public static final java.lang.String GLOBALINFO_STARTTAG

the start comment tag for inserting the generated Javadoc

See Also:

Constant Field Values

GLOBALINFO_ENDTAG

public static final java.lang.String GLOBALINFO_ENDTAG

the end comment tag for inserting the generated Javadoc

See Also:

Constant Field Values

Constructor Detail

GlobalInfoJavadoc

public GlobalInfoJavadoc()

default constructor

Method Detail

generateJavadoc

protected java.lang.String generateJavadoc(int index)
                                    throws java.lang.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:

java.lang.Exception - in case the generation fails

getRevision

public java.lang.String getRevision()

Returns the revision string.

Returns:

the revision

main

public static void main(java.lang.String[] args)

Parses the given commandline parameters and generates the Javadoc.

Parameters:

args - the commandline parameters for the object