weka.core

Class OptionHandlerJavadoc

java.lang.Object

weka.core.Javadoc

weka.core.OptionHandlerJavadoc

All Implemented Interfaces:

OptionHandler, RevisionHandler

public class OptionHandlerJavadoc
extends Javadoc

Generates Javadoc comments from the OptionHandler's options. Can automatically update the option comments if they're surrounded by the OPTIONS_STARTTAG and OPTIONS_ENDTAG (the indention is determined via the OPTIONS_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.

 -noprolog
  Suppresses the 'Valid options are...' prolog in the Javadoc.

Version:

$Revision: 1.8 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

OPTIONS_STARTTAG, OPTIONS_ENDTAG

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_Prolog whether to include the "Valid options..." prolog in the Javadoc
static String	OPTIONS_ENDTAG the end comment tag for inserting the generated Javadoc
static String	OPTIONS_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
OptionHandlerJavadoc() default constructor

Method Summary

Modifier and Type	Method and Description
protected String	generateJavadoc(int index) generates and returns the Javadoc for the specified start/end tag pair.
String[]	getOptions() Gets the current settings of this object.
boolean	getProlog() whether "Valid options are..." prolog is included in the Javadoc
String	getRevision() Returns the revision string.
Enumeration	listOptions() Returns an enumeration describing the available options.
static void	main(String[] args) Parses the given commandline parameters and generates the Javadoc.
void	setOptions(String[] options) Parses a given list of options.
void	setProlog(boolean value) sets whether to add the "Valid options are..." prolog

Methods inherited from class weka.core.Javadoc

canInstantiateClass, generate, generateHelp, generateJavadoc, getClassname, getDir, getIndentionLength, getIndentionString, getInstance, getSilent, getUseStars, indent, println, runJavadoc, setClassname, setDir, 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

OPTIONS_STARTTAG

public static final String OPTIONS_STARTTAG

the start comment tag for inserting the generated Javadoc

See Also:

Constant Field Values

OPTIONS_ENDTAG

public static final String OPTIONS_ENDTAG

the end comment tag for inserting the generated Javadoc

See Also:

Constant Field Values

m_Prolog

protected boolean m_Prolog

whether to include the "Valid options..." prolog in the Javadoc

Constructor Detail

OptionHandlerJavadoc

public OptionHandlerJavadoc()

default constructor

Method Detail

listOptions

public Enumeration listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class Javadoc

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(String[] options)
                throws Exception

Parses a given list of options.

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class Javadoc

Parameters:

options - the list of options as an array of strings

Throws:

Exception - if an option is not supported

getOptions

public String[] getOptions()

Gets the current settings of this object.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class Javadoc

Returns:

an array of strings suitable for passing to setOptions

setProlog

public void setProlog(boolean value)

sets whether to add the "Valid options are..." prolog

Parameters:

value - true if the prolog is to be added

getProlog

public boolean getProlog()

whether "Valid options are..." prolog is included in the Javadoc

Returns:

true if the prolog is printed

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

getRevision

public String getRevision()

Returns the revision string.

Returns:

the revision

main

public static void main(String[] args)

Parses the given commandline parameters and generates the Javadoc.

Parameters:

args - the commandline parameters for the object