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. It is the doclet that is used by the javadoc tool and the system documentation tool when no other doclet is specified to be used.

User-Defined Taglets

The standard doclet supports user-defined taglets, which can be used to generate customized output for user-defined tags in documentation comments. Taglets invoked by the standard doclet must return strings from Taglet.toString as follows:

Inline Tags: The returned string must be flow content, or any valid fragment of HTML code that may appear in the body of a document. There may be additional constraints, depending on how the tag is to be used in a documentation comment: for example, if the tag may be used within an inline element such as <b> or <i>, the taglet must not return a string containing block tags, like <h3> or <p>.
Block Tags: The returned string must be suitable content for a definition list, or <dl> element. It will typically be a series of pairs of <dt> and <dd> elements.

Since:

External Specifications

Nested Class Summary

Nested classes/interfaces declared in interface Doclet

Doclet.Option

Modifier and Type	Interface	Description
`static interface`	`Doclet.Option`	An encapsulation of option name, aliases, parameters and descriptions as used by the Doclet.

Constructor Summary

Constructor	Description
`StandardDoclet()`	Creates an instance of the standard doclet, used to generate HTML-formatted documentation.

Method Summary

Modifier and Type	Method	Description
`Locale`	`getLocale()`	Returns the locale for this doclet.
`String`	`getName()`	Returns a name identifying the doclet.
`Reporter`	`getReporter()`	Returns the reporter for this doclet.
`Set<? extends 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 declared in class Object

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

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

StandardDoclet

public StandardDoclet()

Creates an instance of the standard doclet, used to generate HTML-formatted documentation.