ball.tools.javadoc

Interface Doclet

public interface Doclet

Doclet "interface." Doclets are not actually part of a class hierarchy. The methods described here are static in the implementations. This interface is provided to document the methods and to use as a possible basis for creating Proxy-based solutions. The standard OpenJDK DocumentationTool dispatches to Standard which in-turn dispatches to HtmlDoclet.

Version:

$Revision: 5431 $

Author:

Allen D. Ball

Method Summary

Modifier and Type	Method and Description
LanguageVersion	languageVersion() Return the version of the Java Programming Language supported by this Doclet.
int	optionLength(String option) Check for Doclet added options.
boolean	start(RootDoc root) Starting point for document generation.
boolean	validOptions(String[][] options, DocErrorReporter reporter) Check options have correct arguments.

Method Detail

languageVersion

LanguageVersion languageVersion()

Return the version of the Java Programming Language supported by this Doclet.

Returns:

The minimum LanguageVersion supported by this Doclet.

optionLength

int optionLength(String option)

Check for Doclet added options. E.g., "-d docs" should return 2.

Parameters:

option - The option to check.

Returns:

Number of arguments required to specify; 0 means the option is unknown and a negative value indicates an error.

start

boolean start(RootDoc root)

Starting point for document generation. The Standard supplies an instance of com.sun.tools.javadoc.RootDocImpl Doclet for RootDoc.

Parameters:

root - The RootDoc.

Returns:

true on success; false otherwise.

validOptions

boolean validOptions(String[][] options,
                     DocErrorReporter reporter)

Check options have correct arguments. The Standard supplies an instance of com.sun.tools.javadoc.Messager Doclet for DocErrorReporter.

Parameters:

options - The options and their arguments.

reporter - The DocErrorReporter.

Returns:

true if the options are valid; false otherwise.