com.puppycrawl.tools.checkstyle.doclets

Class TokenTypesDoclet

java.lang.Object

com.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet

public final class TokenTypesDoclet
extends Object

Doclet which is used to write property file with short descriptions (first sentences) of TokenTypes' constants. Request: 724871 For ide plugins (like the eclipse plugin) it would be useful to have programmatic access to the first sentence of the TokenType constants, so they can use them in their configuration gui.

Author:

o_sukhodolsky

Method Summary

Methods

Modifier and Type	Method and Description
static int	optionLength(String option) Returns option length (how many parts are in option).
static boolean	start(com.sun.javadoc.RootDoc root) The doclet's starter method.
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter) Checks that only valid options was specified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)
                     throws FileNotFoundException

The doclet's starter method.

Parameters:

root - 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.

optionLength

public static int optionLength(String option)

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

Parameters:

option - option name to process

Returns:

option length (how many parts are in option).

validOptions

public static boolean validOptions(String[][] options,
                   com.sun.javadoc.DocErrorReporter reporter)

Checks that only valid options was specified.

Parameters:

options - all parsed options

reporter - the reporter to report errors.

Returns:

true if only valid options was specified