APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html.taglets

public Class LiteralTaglet

extends BaseTaglet
Class Inheritance
Imports
java.util.EnumSet, javax.lang.model.element.Element, com.sun.source.doctree.DocTree, .LiteralTree, jdk.javadoc.doclet.Taglet, jdk.javadoc.internal.doclets.formats.html.HtmlConfiguration, jdk.javadoc.internal.html.Content, .HtmlTree, .Text
An inline taglet used to denote literal text, possibly in monospace font. For example, the text:
{@literal a<B>c}
displays as:
a<B>c

The tag {@code ...} is equivalent to <code>{@literal ...}</code>. For example, the text:

The type {@code List<P>}
displays as:
The type List<P>

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet:
configmessagesnameresourcestagKindtagletWriterutils

Constructor Summary

AccessConstructor and Description
pack-priv
LiteralTaglet(HtmlConfiguration config, DocTree.Kind tagKind)

Method Summary

Modifier and TypeMethod and Description
public Content
getInlineTagOutput(Element element, DocTree tag, TagletWriter tagletWriter)

Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput.

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.

Inherited from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet:
getAllBlockTagOutputgetAllowedLocationsgetNamegetTagKindisInlineTag

Constructor Detail

LiteralTagletback to summary
pack-priv LiteralTaglet(HtmlConfiguration config, DocTree.Kind tagKind)

Method Detail

getInlineTagOutputback to summary
public Content getInlineTagOutput(Element element, DocTree tag, TagletWriter tagletWriter)

Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput.

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput.

Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.

Annotations
@Override