程序包 weka.core
类 Javadoc
java.lang.Object
weka.core.Javadoc
- 所有已实现的接口:
OptionHandler
,RevisionHandler
Abstract superclass for classes that generate Javadoc comments and replace
the content between certain comment tags.
- 版本:
- $Revision: 1.6 $
- 作者:
- fracpete (fracpete at waikato dot ac dot nz)
-
构造器概要
构造器 -
方法概要
修饰符和类型方法说明generate()
generates either the plain Javadoc (if no filename specified) or the updated file (if a filename is specified).generates a string to print as help on the consolereturns the current classnamegetDir()
returns the current dir containing the class to update.String[]
Gets the current settings of this object.boolean
whether output in the console is suppressedboolean
whether the Javadoc is prefixed with "*"Returns an enumeration describing the available options.void
setClassname
(String value) sets the classname of the class to generate the Javadoc forvoid
sets the dir containing the file that is to be updated.void
setOptions
(String[] options) Parses a given list of options.void
setSilent
(boolean value) sets whether to suppress output in the consolevoid
setUseStars
(boolean value) sets whether to prefix the Javadoc with "*"generates the Javadoc and returns it applied to the source file if one was provided, otherwise an empty string.从接口继承的方法 weka.core.RevisionHandler
getRevision
-
构造器详细资料
-
Javadoc
public Javadoc()
-
-
方法详细资料
-
listOptions
Returns an enumeration describing the available options.- 指定者:
listOptions
在接口中OptionHandler
- 返回:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options.- 指定者:
setOptions
在接口中OptionHandler
- 参数:
options
- the list of options as an array of strings- 抛出:
Exception
- if an option is not supported
-
getOptions
Gets the current settings of this object.- 指定者:
getOptions
在接口中OptionHandler
- 返回:
- an array of strings suitable for passing to setOptions
-
setClassname
sets the classname of the class to generate the Javadoc for- 参数:
value
- the new classname
-
getClassname
returns the current classname- 返回:
- the current classname
-
setUseStars
public void setUseStars(boolean value) sets whether to prefix the Javadoc with "*"- 参数:
value
- true if stars are used
-
getUseStars
public boolean getUseStars()whether the Javadoc is prefixed with "*"- 返回:
- whether stars are used
-
setDir
sets the dir containing the file that is to be updated. It is the dir above the package hierarchy of the class.- 参数:
value
- the directory containing the classes
-
getDir
returns the current dir containing the class to update. It is the dir above the package name of the class.- 返回:
- the current directory
-
setSilent
public void setSilent(boolean value) sets whether to suppress output in the console- 参数:
value
- true if output is to be suppressed
-
getSilent
public boolean getSilent()whether output in the console is suppressed- 返回:
- true if output is suppressed
-
updateJavadoc
generates the Javadoc and returns it applied to the source file if one was provided, otherwise an empty string.- 返回:
- the generated Javadoc
- 抛出:
Exception
- in case the generation fails
-
generate
generates either the plain Javadoc (if no filename specified) or the updated file (if a filename is specified). The start and end tag for the global info have to be specified in the file in the latter case.- 返回:
- either the plain Javadoc or the modified file
- 抛出:
Exception
- in case the generation fails
-
generateHelp
generates a string to print as help on the console- 返回:
- the generated help
-