com.puppycrawl.tools.checkstyle.doclets

Class CheckDocsDoclet

public final class CheckDocsDoclet extends Object

Doclet which is used to extract Anakia input files from the Javadoc of Check implementations, so the Check's docs are autogenerated.

Author: lkuehne

Method Summary
static StringgetDestDir(String[][] aOptions)
Return the destination directory for this Javadoc run.
static intoptionLength(String aOption)
Returns option length (how many parts are in option).
static booleanstart(RootDoc aRoot)
Doclet entry point.

Method Detail

getDestDir

public static String getDestDir(String[][] aOptions)
Return the destination directory for this Javadoc run.

Parameters: aOptions Javadoc commandline options

Returns: 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).

Parameters: aOption option name to process

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

start

public static boolean start(RootDoc aRoot)
Doclet entry point.

Parameters: aRoot parsed javadoc of all java files passed to the javadoc task

Returns: true (TODO: semantics of the return value is not clear to me)

Throws: IOException if there are problems writing output