|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.doclets.TokenTypesDoclet
public class TokenTypesDoclet
Doclet which is used to write property file with short descriptions (first sentences) of TokenTypes' constants.
| Constructor Summary | |
|---|---|
TokenTypesDoclet()
|
|
| Method Summary | |
|---|---|
static int |
optionLength(String aOption)
Returns option length (how many parts are in option). |
static boolean |
start(com.sun.javadoc.RootDoc aRoot)
The doclet's starter method. |
static boolean |
validOptions(String[][] aOptions,
com.sun.javadoc.DocErrorReporter aReporter)
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 |
| Constructor Detail |
|---|
public TokenTypesDoclet()
| Method Detail |
|---|
public static boolean start(com.sun.javadoc.RootDoc aRoot)
throws FileNotFoundException
aRoot - RootDoc given to the doclet
RootDoc is processed.
FileNotFoundException - will be thrown if the doclet
will be unable to write to the specified file.public static int optionLength(String aOption)
aOption - option name to process
public static boolean validOptions(String[][] aOptions,
com.sun.javadoc.DocErrorReporter aReporter)
aOptions - all parsed optionsaReporter - the reporter to report errors.
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||