com.puppycrawl.tools.checkstyle.doclets

Class TokenTypesDoclet

public class TokenTypesDoclet extends Object

Doclet which is used to write property file with short descriptions (first sentences) of TokenTypes' constants.

Author: o_sukhodolsky

Method Summary
static intoptionLength(String aOption)
Returns option length (how many parts are in option).
static booleanstart(RootDoc aRoot)
The doclet's starter method.
static booleanvalidOptions(String[][] aOptions, DocErrorReporter aReporter)
Checks that only valid options was specified.

Method Detail

optionLength

public static int optionLength(String aOption)
Returns option length (how many parts are in option).

Parameters: aOption option name to process

Returns: option length (how many parts are in option).

start

public static boolean start(RootDoc aRoot)
The doclet's starter method.

Parameters: aRoot RootDoc given to the doclet

Returns: true if the given RootDoc is processed.

Throws: FileNotFoundException will be thrown if the doclet will be unable to write to the specified file.

validOptions

public static boolean validOptions(String[][] aOptions, DocErrorReporter aReporter)
Checks that only valid options was specified.

Parameters: aOptions all parsed options aReporter the reporter to report errors.

Returns: true if only valid options was specified