Doclet
public class StandardDoclet extends Object implements Doclet
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: <b>
or <i>
, the taglet must not return a string containing block tags, like <h3>
or <p>
. <dl>
element. It will typically be a series of pairs of <dt>
and <dd>
elements. Doclet.Option
Constructor | Description |
---|---|
StandardDoclet() |
Creates an instance of the standard doclet, used to generate HTML-formatted documentation. |
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 |
getSupportedOptions() |
Returns all the supported options. |
SourceVersion |
getSupportedSourceVersion() |
Returns the version of the Java Programming Language supported by this doclet. |
void |
init |
Initializes this doclet with the given locale and error reporter. |
boolean |
run |
The entry point of the doclet. |
public StandardDoclet()
public void init(Locale locale, Reporter reporter)
Doclet
public String getName()
Doclet
public Set<? extends Doclet.Option> getSupportedOptions()
Doclet
getSupportedOptions
in interface Doclet
public SourceVersion getSupportedSourceVersion()
Doclet
getSupportedSourceVersion
in interface Doclet
public boolean run(DocletEnvironment docEnv)
Doclet
public Locale getLocale()
public Reporter getReporter()
© 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