java.lang.Object
jdk.javadoc.doclet.StandardDoclet
- All Implemented Interfaces:
- Doclet
This doclet generates HTML-formatted documentation for the specified modules,
 packages and types.
 
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.
- External Specifications
- 
Nested Class SummaryNested classes/interfaces declared in interface jdk.javadoc.doclet.DocletDoclet.Option
- 
Constructor SummaryConstructorsConstructorDescriptionCreates an instance of the standard doclet, used to generate HTML-formatted documentation.
- 
Method SummaryModifier 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.voidInitializes this doclet with the given locale and error reporter.booleanrun(DocletEnvironment docEnv) The entry point of the doclet.
- 
Constructor Details- 
StandardDocletpublic StandardDoclet()Creates an instance of the standard doclet, used to generate HTML-formatted documentation.
 
- 
- 
Method Details- 
initDescription copied from interface:DocletInitializes this doclet with the given locale and error reporter. This locale will be used by the reporter and the doclet components.
- 
getNameDescription copied from interface:DocletReturns 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".
- 
getSupportedOptionsDescription copied from interface:DocletReturns all the supported options.- Specified by:
- getSupportedOptionsin interface- Doclet
- Returns:
- a set containing all the supported options, an empty set if none
 
- 
getSupportedSourceVersionDescription copied from interface:DocletReturns the version of the Java Programming Language supported by this doclet.- Specified by:
- getSupportedSourceVersionin interface- Doclet
- Returns:
- the language version supported by this doclet, usually the latest version
 
- 
runDescription copied from interface:DocletThe entry point of the doclet. Further processing will commence as instructed by this method.
- 
getLocaleReturns the locale for this doclet.- Returns:
- the locale for this doclet
- Since:
- 17
- See Also:
 
- 
getReporterReturns the reporter for this doclet.- Returns:
- the reporter for this doclet
- Since:
- 17
- See Also:
 
 
-