W3cubDocs

/OpenJDK 21

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.

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.
External Specifications

Nested Class Summary

Nested classes/interfaces declared in interface jdk.javadoc.doclet.Doclet

Doclet.Option

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 java.lang.Object

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

Constructor Details

StandardDoclet

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

Method Details

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<? extends 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

getLocale

public Locale getLocale()
Returns the locale for this doclet.
Returns:
the locale for this doclet
Since:
17
See Also:

getReporter

public Reporter getReporter()
Returns the reporter for this doclet.
Returns:
the reporter for this doclet
Since:
17
See Also:

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.javadoc/jdk/javadoc/doclet/StandardDoclet.html