com.puppycrawl.tools.checkstyle.doclets

Class CheckDocsDoclet

java.lang.Object

com.puppycrawl.tools.checkstyle.doclets.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. Attention: this is incomplete autogenerator of Check's documentation from the Check's javadoc. It is not used now, and should be removed from master branch till completed.

Author:

lkuehne

Method Summary

Methods

Modifier and Type	Method and Description
static String	getDestDir(String[][] options) Return the destination directory for this Javadoc run.
static int	optionLength(String option) Returns option length (how many parts are in option).
static boolean	start(com.sun.javadoc.RootDoc root) Doclet entry point.

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 IOException

Doclet entry point.

Parameters:

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

getDestDir

public static String getDestDir(String[][] options)

Return the destination directory for this Javadoc run.

Parameters:

options - Javadoc commandline options

Returns:

the dest dir specified on the command line (or ant task)

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