com.manoelcampos.javadoc.coverage

Class CoverageDoclet

java.lang.Object

com.manoelcampos.javadoc.coverage.CoverageDoclet

public class CoverageDoclet
extends Object

A Doclet that computes coverage of JavaDoc documentation. It is the entry point for the JavaDoc Tool, which can be executed either directly using the JavaDoc command line tool or from maven.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

See Also:

ConsoleExporter, Doclet Overview

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	OUTPUT_NAME_OPTION A command line parameter to enable defining the name of the coverage report.

Constructor Summary

Constructors

Constructor and Description
CoverageDoclet(com.sun.javadoc.RootDoc rootDoc) Instantiate the Doclet which will parse the JavaDocs and generate the coverage report.

Method Summary

Modifier and Type	Method and Description
String[]	getOptionValues(String[] optionNames) Gets the values associated to a given command line option.
File	getOutputFile(String fileName) Gets a File object from a given file name.
com.sun.javadoc.RootDoc	getRootDoc() Gets the root element which enables reading JavaDoc documentation from the Java files given to the JavaDoc tool.
PrintWriter	getWriter(File file) Gets a PrintWriter used by the exporter to write the coverage report to.
static com.sun.javadoc.LanguageVersion	languageVersion() Gets the version of the Java Programming Language supported by this doclet.
static int	optionLength(String option) Gets the number of arguments that a given command line option must contain.
static boolean	start(com.sun.javadoc.RootDoc rootDoc) Starts the actual parsing or JavaDoc documentation and generation of the coverage report.
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter errorReporter) Validates command line options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OUTPUT_NAME_OPTION

public static final String[] OUTPUT_NAME_OPTION

A command line parameter to enable defining the name of the coverage report. The first value is the long version of the parameter name and the second is the short one.

Constructor Detail

CoverageDoclet

public CoverageDoclet(com.sun.javadoc.RootDoc rootDoc)

Instantiate the Doclet which will parse the JavaDocs and generate the coverage report.

Parameters:

rootDoc - root element which enables reading JavaDoc documentation

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc rootDoc)

Starts the actual parsing or JavaDoc documentation and generation of the coverage report. This is the entry point for the JavaDoc tool to start the Doclet.

Parameters:

rootDoc - root element which enables reading JavaDoc documentation

Returns:

true if the Doclet was started successfully, false otherwise

See Also:

Doclet.start(RootDoc)

validOptions

public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter errorReporter)

Validates command line options.

Parameters:

options - the array of given options

errorReporter - an object that allows printing error messages for invalid options

Returns:

true if the options are valid, false otherwise

See Also:

Doclet.validOptions(String[][], DocErrorReporter)

optionLength

public static int optionLength(String option)

Gets the number of arguments that a given command line option must contain.

Parameters:

option - the command line option

Returns:

the number of arguments required for the given option

See Also:

Doclet.optionLength(String)

getOptionValues

public String[] getOptionValues(String[] optionNames)

Gets the values associated to a given command line option.

Parameters:

optionNames - an array containing the valid names for the command line option to get its associated values. This array may include the long and short versions of the option name, for instance {-outputName, -o}.

Returns:

the values associated to the option, where the 0th element is the option itself; or an empty array if the option is invalid.

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

Gets the version of the Java Programming Language supported by this doclet.

Returns:

the Java language supported version

See Also:

Doclet.languageVersion()

getRootDoc

public com.sun.javadoc.RootDoc getRootDoc()

Gets the root element which enables reading JavaDoc documentation from the Java files given to the JavaDoc tool.

getWriter

public PrintWriter getWriter(File file)
                      throws FileNotFoundException

Gets a PrintWriter used by the exporter to write the coverage report to.

Parameters:

file - the file to which the coverage report will be saved to

Throws:

FileNotFoundException

getOutputFile

public File getOutputFile(String fileName)

Gets a File object from a given file name.

Parameters:

fileName - the name of the file to get a File object.

Returns:

the File object