OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.taglets

Package jdk.javadoc.internal.doclets.formats.html.taglets

Classes used to build the output for documentation comment tags. Tags are either inline tags, meaning they can be used within a sentence or phrase, or are block tags, meaning that they provide additional details that follow the main description in a comment. Taglets model that distinction. Inline tags are always processed individually, within the surrounding context. In general, inline tags always generate some (non-empty) output, even if the output is some form indicating an error. It is almost never correct to not generate any output to place between the parts of the comment that come before and after the tag in the underlying comment. Conversely, block tags of any given kind are always processed as a group, even if they do not appear contiguously in the underlying comment.

Interface Summary

Modifier and Type	Interface and Description
public interface	InheritableTaglet A taglet should implement this interface if it supports an `{@inheritDoc}` tag or is automatically inherited if it is missing.
public interface	Taglet This is the taglet interface used internally within the doclet.

Class Summary

Modifier and Type	Class and Description
public class	BaseTaglet A base class that implements the `Taglet` interface.
public class	DeprecatedTaglet A taglet that represents the `@deprecated` tag.
public class	DocRootTaglet An inline taglet representing `{@docRoot}`.
public class	IndexTaglet An inline taglet used to index a word or a phrase.
public class	InheritDocTaglet A taglet that represents the `{@inheritDoc}` tag.
public class	LinkTaglet A taglet that represents the `{@link ...}` and ... tags, with support for links to program elements in `@see` and `{@snippet ...}` tags.
public class	LiteralTaglet An inline taglet used to denote literal text, possibly in monospace font.
public class	ParamTaglet A taglet that represents the `@param` tag.
public class	ReturnTaglet A taglet that represents the `@return` and `{@return }` tags.
public class	SeeTaglet
public class	SimpleTaglet A custom single-argument block tag.
public class	SnippetTaglet A taglet that represents the `@snippet` tag.
public class	SpecTaglet A taglet that represents the `@spec` tag.
public class	SummaryTaglet A taglet that represents the `{@summary}` tag.
public class	SystemPropertyTaglet A taglet that represents the `@systemProperty` tag.
public class	TagletManager Manages the `Taglet`s used by the standard doclet.
public class	TagletWriter Context and utility methods for taglet classes.
public class	ThrowsTaglet A taglet that processes `ThrowsTree`, which represents `@throws` and `@exception` tags, collectively referred to as exception tags.
public class	UserTaglet A taglet wrapper, allows the public taglet `jdk.javadoc.doclet.Taglet` wrapped into an internal `Taglet` representation.
public class	ValueTaglet An inline taglet representing the value tag.