com.puppycrawl.tools.checkstyle.doclets
Class TokenTypesDoclet
public class TokenTypesDoclet
Doclet which is used to write property file with short descriptions
(first sentences) of TokenTypes' constants.
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.
|
optionLength
public static int optionLength(String aOption)
Returns option length (how many parts are in option).
aOption - option name to process
- option length (how many parts are in option).
start
public static boolean start(RootDoc aRoot)
throws FileNotFoundException The doclet's starter method.
aRoot - RootDoc given to the doclet
- true if the given
RootDoc is processed.
validOptions
public static boolean validOptions(aOptions[][] ,
DocErrorReporter aReporter) Checks that only valid options was specified.
aReporter - the reporter to report errors.
- true if only valid options was specified