|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class StandardDoclet
jdk.javadoc.doclet.StandardDoclet
All Implemented Interfaces:
public class StandardDoclet
This doclet generates HTML-formatted documentation for the specified modules,
packages and types.
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.
See Also:
Nested classes/interfaces inherited from interface jdk.javadoc.doclet. Doclet |
|
Constructor Summary |
Creates an instance of the standard doclet, used to generate HTML-formatted
documentation.
|
Method Summary |
|
Returns the locale for this doclet
|
|
Returns a name identifying the doclet.
|
|
Returns the reporter for this doclet
|
|
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 |
The entry point of the doclet.
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Creates an instance of the standard doclet, used to generate HTML-formatted
documentation.
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:
Parameters:
locale - the locale to be used
reporter - the reporter to be used
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:
Returns:
name of the Doclet
Description copied from interface:
Doclet
Returns all the supported options.
Specified by:
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:
Returns:
the language version supported by this doclet, usually
the latest version
Description copied from interface:
Doclet
The entry point of the doclet. Further processing will commence as
instructed by this method.
Specified by:
Parameters:
docEnv - from which essential information can be extracted
Returns:
true on success
Returns the locale for this doclet
Returns:
the locale for this doclet
Since:
17
See Also:
Returns the reporter for this doclet
Returns:
the reporter for this doclet
Since:
17
See Also:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz