APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.doclet

public Class StandardDoclet

extends Object
implements Doclet
Class Inheritance
All Implemented Interfaces
jdk.javadoc.doclet.Doclet
Imports
java.util.Locale, .List, .Set, javax.lang.model.element.Element, javax.lang.model.SourceVersion, jdk.javadoc.internal.doclets.formats.html.HtmlDoclet
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
9
External Specification
Documentation Comment Specification for the Standard Doclet, https://www.w3.org/TR/html52

Field Summary

Modifier and TypeField and Description
private final HtmlDoclet
htmlDoclet

Constructor Summary

AccessConstructor and Description
public
StandardDoclet()

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

Method Summary

Modifier and TypeMethod and Description
public Locale

Returns:

the locale for this doclet
getLocale()

Returns the locale for this doclet.

public String
getName()

Implements jdk.javadoc.doclet.Doclet.getName.

Returns a name identifying the doclet.

public Reporter

Returns:

the reporter for this doclet
getReporter()

Returns the reporter for this doclet.

public Set<? extends Doclet.Option>
getSupportedOptions()

Implements jdk.javadoc.doclet.Doclet.getSupportedOptions.

Returns all the supported options.

public SourceVersion
getSupportedSourceVersion()

Implements jdk.javadoc.doclet.Doclet.getSupportedSourceVersion.

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

public void
init(Locale locale, Reporter reporter)

Implements jdk.javadoc.doclet.Doclet.init.

Initializes this doclet with the given locale and error reporter.

public boolean
run(DocletEnvironment docEnv)

Implements jdk.javadoc.doclet.Doclet.run.

The entry point of the doclet.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

htmlDocletback to summary
private final HtmlDoclet htmlDoclet

Constructor Detail

StandardDocletback to summary
public StandardDoclet()

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

Annotations
@SuppressWarnings:this-escape

Method Detail

getLocaleback to summary
public Locale getLocale()

Returns the locale for this doclet.

Returns:Locale

the locale for this doclet

Since
17
See Also
init(Locale, Reporter)
getNameback to summary
public String getName()

Implements jdk.javadoc.doclet.Doclet.getName.

Doc from jdk.javadoc.doclet.Doclet.getName.

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".

Annotations
@Override
getReporterback to summary
public Reporter getReporter()

Returns the reporter for this doclet.

Returns:Reporter

the reporter for this doclet

Since
17
See Also
init(Locale, Reporter)
getSupportedOptionsback to summary
public Set<? extends Doclet.Option> getSupportedOptions()

Implements jdk.javadoc.doclet.Doclet.getSupportedOptions.

Doc from jdk.javadoc.doclet.Doclet.getSupportedOptions.

Returns all the supported options.

Annotations
@Override
getSupportedSourceVersionback to summary
public SourceVersion getSupportedSourceVersion()

Implements jdk.javadoc.doclet.Doclet.getSupportedSourceVersion.

Doc from jdk.javadoc.doclet.Doclet.getSupportedSourceVersion.

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

Annotations
@Override
initback to summary
public void init(Locale locale, Reporter reporter)

Implements jdk.javadoc.doclet.Doclet.init.

Doc from jdk.javadoc.doclet.Doclet.init.

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

Annotations
@Override
runback to summary
public boolean run(DocletEnvironment docEnv)

Implements jdk.javadoc.doclet.Doclet.run.

Doc from jdk.javadoc.doclet.Doclet.run.

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

Annotations
@Override