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 int
optionLength(String aOption)
Returns option length (how many parts are in option).
static boolean
start(RootDoc aRoot)
The doclet's starter method.
static boolean
validOptions(aOptions[][] , DocErrorReporter aReporter)
Checks that only valid options was specified.

Method Details

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)
            throws FileNotFoundException
The doclet's starter method.
Parameters:
aRoot - RootDoc given to the doclet
Returns:
true if the given RootDoc is processed.

validOptions

public static boolean validOptions(aOptions[][] ,
                                   DocErrorReporter aReporter)
Checks that only valid options was specified.
Parameters:
aReporter - the reporter to report errors.
Returns:
true if only valid options was specified