weka.core

Class AllJavadoc

java.lang.Object

weka.core.Javadoc

weka.core.AllJavadoc

All Implemented Interfaces:

OptionHandler, RevisionHandler

public class AllJavadoc
extends Javadoc

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

Version:

$Revision: 6110 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field and Description
protected static Vector	m_Javadocs contains all the

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

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	getRevision() Returns the revision string.
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 weka.core.Javadoc

canInstantiateClass, generate, generateHelp, generateJavadoc, getClassname, getDir, getIndentionLength, getIndentionString, getInstance, getOptions, getSilent, getUseStars, indent, listOptions, println, runJavadoc, setDir, setOptions, toHTML, updateJavadoc, updateJavadoc

Methods inherited from class java.lang.Object

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

Field Detail

m_Javadocs

protected static Vector m_Javadocs

contains all the

Constructor Detail

AllJavadoc

public AllJavadoc()

Method Detail

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

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