| com.sun.tools.doclets.internal.toolkit.taglets |
com.sun.tools.doclets.internal.toolkit.taglets package
This package has classes used to generate Javadoc tag documentation.
Doclets no longer have to implement its own version of standard tags
such as @param and @throws. This is the single, doclet
implementation of each standard tag that is shared by all
doclets. Each doclet must have a taglet writer that takes a taglet
as input and writes doclet-dependent output. The taglet itself will
do the tag processing. For example, suppose we are outputing
@throws tags. The taglet would:
- Retrieve the list of throws tags to be documented.
- Replace {@inheritDoc} with the appropriate documentation.
- Add throws documentation for exceptions that are declared in
the signature of the method but
not documented with the throws tags.
After doing the steps above, the taglet would pass the information to
the taglet writer for writing. The taglets are essentially builders for
tags.
This code is not part of an API.
It is implementation that is subject to change.
Do not use it as an API.
|
| Java Source File Name | Type | Comment |
| BaseExecutableMemberTaglet.java | Class | An abstract class for that implements the
Taglet interface
for tags in ExecutableMembers. |
| BaseInlineTaglet.java | Class | An abstract inline taglet that outputs HTML. |
| BaseTaglet.java | Class | An abstract class for that implements the
Taglet interface. |
| CodeTaglet.java | Class | An inline Taglet used to denote literal code fragments.
The enclosed text is interpreted as not containing HTML markup or
nested javadoc tags, and is rendered in a font suitable for code.
The tag
... |
| DeprecatedTaglet.java | Class | A taglet that represents the @deprecated tag. |
| DocRootTaglet.java | Class | An inline Taglet representing {@docRoot}. |
| InheritableTaglet.java | Interface | A taglet should implement this interface if it supports the inheritDoc
tag or is automatically inherited if it is missing. |
| InheritDocTaglet.java | Class | An inline Taglet representing the inheritDoc tag. |
| LegacyTaglet.java | Class | This taglet acts as a wrapper to enable
com.sun.tools.doclets.Taglet type taglets to work
with the current version of Javadoc. |
| LiteralTaglet.java | Class | An inline Taglet used to denote literal text. |
| ParamTaglet.java | Class | A taglet that represents the @param tag. |
| ReturnTaglet.java | Class | A taglet that represents the @return tag. |
| SeeTaglet.java | Class | A taglet that represents the @see tag. |
| SimpleTaglet.java | Class | A simple single argument custom tag. |
| Taglet.java | Interface | The interface for a custom tag used by Doclets. |
| TagletManager.java | Class | Manages theTaglets used by doclets. |
| TagletOutput.java | Interface | The interface for taglet output. |
| TagletWriter.java | Class | The interface for the taglet writer. |
| ThrowsTaglet.java | Class | A taglet that represents the @throws tag. |
| ValueTaglet.java | Class | An inline Taglet representing the value tag. |