com.puppycrawl.tools.checkstyle.doclets
Class 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.
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(RootDoc aRoot) - Doclet entry point.
|
getDestDir
public static String getDestDir(String[][] aOptions)
Return the destination directory for this Javadoc run.
aOptions
- Javadoc commandline options
- the dest dir specified on the command line (or ant task)
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 IOException
Doclet entry point.
aRoot
- parsed javadoc of all java files passed to the javadoc task
- true (TODO: semantics of the return value is not clear to me)