Module jdk.javadoc

Package jdk.javadoc.doclet

Class StandardDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

All Implemented Interfaces:

Doclet

public class StandardDoclet
extends Object
implements Doclet

This doclet generates HTML-formatted documentation for the specified modules, packages and types.

See Also:

Documentation Comment Specification for the Standard Doclet

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet

Doclet.Option

Constructor Summary

Constructors

Constructor	Description
StandardDoclet()

Method Summary

Modifier and Type	Method	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 docEnv)	The entry point of the doclet.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardDoclet

public StandardDoclet()

Method Detail

init

public void init(Locale locale,
                 Reporter reporter)

Description copied from interface: Doclet

Initializes this doclet with the given locale and error reporter. This locale will be used by the reporter and the doclet components.

Specified by:

init in interface Doclet

Parameters:

locale - the locale to be used

reporter - the reporter to be used

getName

public String getName()

Description copied from interface: Doclet

Returns a name identifying the doclet. A name is a simple identifier without white spaces, as defined in The Java™ Language Specification, section 6.2 "Names and Identifiers".

Specified by:

getName in interface Doclet

Returns:

name of the Doclet

getSupportedOptions

public Set<Doclet.Option> getSupportedOptions()

Description copied from interface: Doclet

Returns all the supported options.

Specified by:

getSupportedOptions in interface Doclet

Returns:

a set containing all the supported options, an empty set if none

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Description copied from interface: Doclet

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

Specified by:

getSupportedSourceVersion in interface Doclet

Returns:

the language version supported by this doclet, usually the latest version

run

public boolean run(DocletEnvironment docEnv)

Description copied from interface: Doclet

The entry point of the doclet. Further processing will commence as instructed by this method.

Specified by:

run in interface Doclet

Parameters:

docEnv - from which essential information can be extracted

Returns:

true on success