public interface Doclet
Doclet
"interface." Doclet
s 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
.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. |
boolean validOptions(String[][] options, DocErrorReporter reporter)
options
have correct arguments.
The Standard
supplies an
instance of com.sun.tools.javadoc.Messager
Doclet
for
DocErrorReporter
.options
- The options
and their arguments.reporter
- The DocErrorReporter
.true
if the options
are valid; false
otherwise.int optionLength(String option)
option
- The option
to check.0
means the
option is unknown and a negative value indicates an error.boolean start(RootDoc root)
Standard
supplies an
instance of com.sun.tools.javadoc.RootDocImpl
Doclet
for RootDoc
.root
- The RootDoc
.true
on success; false
otherwise.LanguageVersion languageVersion()
Doclet
.LanguageVersion
supported by this
Doclet
.Copyright © 2015–2020 Allen D. Ball. All rights reserved.