OptionHandlerJavadoc

Overview | Package | Class | Tree | Deprecated | Index | Help | Weka's home

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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
`static java.lang.String` | `OPTIONS_ENDTAG` the end comment tag for inserting the generated Javadoc
`static java.lang.String` | `OPTIONS_STARTTAG` the start comment tag for inserting the generated Javadoc

Constructor Summary
`OptionHandlerJavadoc()` default constructor

Method Summary
`java.lang.String[]` | `getOptions()` Gets the current settings of this object.
`boolean` | `getProlog()` whether "Valid options are..." prolog is included in the Javadoc
`java.lang.String` | `getRevision()` Returns the revision string.
`java.util.Enumeration` | `listOptions()` Returns an enumeration describing the available options.
`static void` | `main(java.lang.String[] args)` Parses the given commandline parameters and generates the Javadoc.
`void` | `setOptions(java.lang.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
`generate, generateHelp, getClassname, getDir, getSilent, getUseStars, setClassname, setDir, setSilent, setUseStars, updateJavadoc`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### OPTIONS_STARTTAG

    public static final java.lang.String OPTIONS_STARTTAG

  the start comment tag for inserting the generated Javadoc

  See Also:
    Constant Field Values

### OPTIONS_ENDTAG

    public static final java.lang.String OPTIONS_ENDTAG

  the end comment tag for inserting the generated Javadoc

  See Also:
    Constant Field Values

Constructor Detail

### OptionHandlerJavadoc

    public OptionHandlerJavadoc()

  default constructor

Method Detail

### listOptions

    public java.util.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(java.lang.String[] options)
                    throws java.lang.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:
    `java.lang.Exception` - if an option is not supported

### getOptions

    public java.lang.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

### getRevision

    public java.lang.String getRevision()

  Returns the revision string.

  Returns:
    the revision

### main

    public static void main(java.lang.String[] args)

  Parses the given commandline parameters and generates the Javadoc.

  Parameters:
    `args` - the commandline parameters for the object

Overview | Package | Class | Tree | Deprecated | Index | Help | Weka's home

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD