public interface Doclet
init
method with an appropriate locale
and reporter.
getSupportedOptions
,
and getSupportedSourceVersion
.
These methods are only called once.
run
method on the doclet
object, giving it a DocletEnvironment object, from which the doclet can determine
the elements to be included in the documentation.
If a doclet object is created and used without the above protocol being followed, then the doclet's behavior is not defined by this interface specification.
To start the doclet, pass -doclet
followed by the fully-qualified
name of the entry point class (i.e. the implementation of this interface) on
the javadoc tool command line.
Modifier and Type | Interface and Description |
---|---|
static interface |
Doclet.Option
An encapsulation of option name, aliases, parameters and descriptions
as used by the Doclet.
|
Modifier and Type | Method and Description |
---|---|
String |
getName()
Returns a name identifying the doclet.
|
Set<Doclet.Option> |
getSupportedOptions()
Returns all the supported options.
|
SourceVersion |
getSupportedSourceVersion()
Returns the version of the Java Programming Language supported
by this doclet.
|
void |
init(Locale locale,
Reporter reporter)
Initializes this doclet with the given locale and error reporter.
|
boolean |
run(DocletEnvironment environment)
The entry point of the doclet.
|
void init(Locale locale, Reporter reporter)
locale
- the locale to be usedreporter
- the reporter to be usedString getName()
Set<Doclet.Option> getSupportedOptions()
SourceVersion getSupportedSourceVersion()
boolean run(DocletEnvironment environment)
environment
- from which essential information can be extracted Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2016, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-2016-03-31-172659.buildd.src