Class StandardDoclet
java.lang.Object
jdk.javadoc.doclet.StandardDoclet
- All Implemented Interfaces:
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-definedtaglets
,
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 Specifications
-
Nested Class Summary
Nested classes/interfaces declared in interface Doclet
Doclet.Option
Modifier and TypeInterfaceDescriptionstatic interface
An encapsulation of option name, aliases, parameters and descriptions as used by the Doclet. -
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of the standard doclet, used to generate HTML-formatted documentation. -
Method Summary
Modifier and TypeMethodDescriptionReturns the locale for this doclet.getName()
Returns a name identifying the doclet.Returns the reporter for this doclet.Set
<? extends Doclet.Option> Returns all the supported options.Returns the version of the Java Programming Language supported by this doclet.void
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 TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
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 thisObject
.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
Wakes up all threads that are waiting on this object's monitor.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.
-
-
Method Details
-
init
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. -
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". -
getSupportedOptions
Description copied from interface:Doclet
Returns all the supported options.- Specified by:
getSupportedOptions
in interfaceDoclet
- Returns:
- a set containing all the supported options, an empty set if none
-
getSupportedSourceVersion
Description copied from interface:Doclet
Returns the version of the Java Programming Language supported by this doclet.- Specified by:
getSupportedSourceVersion
in interfaceDoclet
- Returns:
- the language version supported by this doclet, usually the latest version
-
run
Description copied from interface:Doclet
The entry point of the doclet. Further processing will commence as instructed by this method. -
getLocale
Returns the locale for this doclet.- Returns:
- the locale for this doclet
- Since:
- 17
- See Also:
-
getReporter
Returns the reporter for this doclet.- Returns:
- the reporter for this doclet
- Since:
- 17
- See Also:
-