|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.doclets.CheckDocsDoclet
public final class CheckDocsDoclet
Doclet which is used to extract Anakia input files from the Javadoc of Check implementations, so the Check's docs are autogenerated.
| Constructor Summary | |
|---|---|
CheckDocsDoclet()
|
|
| Method Summary | |
|---|---|
static String |
getDestDir(String[][] aOptions)
Return the destination directory for this Javadoc run. |
static int |
optionLength(String aOption)
Returns option length (how many parts are in option). |
static boolean |
start(com.sun.javadoc.RootDoc aRoot)
Doclet entry point. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public CheckDocsDoclet()
| Method Detail |
|---|
public static boolean start(com.sun.javadoc.RootDoc aRoot)
throws IOException
aRoot - parsed javadoc of all java files passed to the javadoc task
IOException - if there are problems writing outputpublic static String getDestDir(String[][] aOptions)
aOptions - Javadoc commandline options
public static int optionLength(String aOption)
aOption - option name to process
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||