程序包 weka.core
类 OptionHandlerJavadoc
java.lang.Object
weka.core.Javadoc
weka.core.OptionHandlerJavadoc
- 所有已实现的接口:
OptionHandler
,RevisionHandler
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.
- 版本:
- $Revision: 1.8 $
- 作者:
- fracpete (fracpete at waikato dot ac dot nz)
- 另请参阅:
-
字段概要
字段 -
构造器概要
构造器 -
方法概要
修饰符和类型方法说明String[]
Gets the current settings of this object.boolean
whether "Valid options are..." prolog is included in the JavadocReturns the revision string.Returns an enumeration describing the available options.static void
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从类继承的方法 weka.core.Javadoc
generate, generateHelp, getClassname, getDir, getSilent, getUseStars, setClassname, setDir, setSilent, setUseStars, updateJavadoc
-
字段详细资料
-
构造器详细资料
-
OptionHandlerJavadoc
public OptionHandlerJavadoc()default constructor
-
-
方法详细资料
-
listOptions
Returns an enumeration describing the available options.- 指定者:
listOptions
在接口中OptionHandler
- 覆盖:
listOptions
在类中Javadoc
- 返回:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options.- 指定者:
setOptions
在接口中OptionHandler
- 覆盖:
setOptions
在类中Javadoc
- 参数:
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
- 覆盖:
getOptions
在类中Javadoc
- 返回:
- an array of strings suitable for passing to setOptions
-
setProlog
public void setProlog(boolean value) sets whether to add the "Valid options are..." prolog- 参数:
value
- true if the prolog is to be added
-
getProlog
public boolean getProlog()whether "Valid options are..." prolog is included in the Javadoc- 返回:
- true if the prolog is printed
-
getRevision
Returns the revision string.- 返回:
- the revision
-
main
Parses the given commandline parameters and generates the Javadoc.- 参数:
args
- the commandline parameters for the object
-