程序包 weka.core

类 Javadoc

java.lang.Object
weka.core.Javadoc
所有已实现的接口:
OptionHandler, RevisionHandler
直接已知子类:
AllJavadoc, GlobalInfoJavadoc, OptionHandlerJavadoc, TechnicalInformationHandlerJavadoc

public abstract class Javadoc extends Object implements 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)
  • 构造器详细资料

    • Javadoc

      public Javadoc()
  • 方法详细资料

    • listOptions

      public Enumeration listOptions()
      Returns an enumeration describing the available options.
      指定者:
      listOptions 在接口中 OptionHandler
      返回:
      an enumeration of all the available options.
    • setOptions

      public void setOptions(String[] options) throws Exception
      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

      public String[] getOptions()
      Gets the current settings of this object.
      指定者:
      getOptions 在接口中 OptionHandler
      返回:
      an array of strings suitable for passing to setOptions
    • setClassname

      public void setClassname(String value)
      sets the classname of the class to generate the Javadoc for
      参数:
      value - the new classname
    • getClassname

      public String 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

      public void setDir(String value)
      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

      public String 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

      public String updateJavadoc() throws Exception
      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

      public String generate() throws Exception
      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

      public String generateHelp()
      generates a string to print as help on the console
      返回:
      the generated help