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

public Class DocRootTaglet

extends BaseTaglet
Class Inheritance
Imports
java.util.EnumSet, javax.lang.model.element.Element, com.sun.source.doctree.DocTree, jdk.javadoc.doclet.Taglet, jdk.javadoc.internal.doclets.formats.html.HtmlConfiguration, .Content, jdk.javadoc.internal.doclets.formats.html.markup.Text
An inline taglet representing {@docRoot}. This taglet is used to get the relative path to the document's root output directory.

Field Summary

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

Constructor Summary

AccessConstructor and Description
pack-priv
DocRootTaglet(HtmlConfiguration config)

Method Summary

Modifier and TypeMethod and Description
public Content
getInlineTagOutput(Element
the element for the enclosing doc comment
holder, DocTree
the tag
tag, TagletWriter
the taglet-writer used in this doclet
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

DocRootTagletback to summary
pack-priv DocRootTaglet(HtmlConfiguration config)

Method Detail

getInlineTagOutputback to summary
public Content getInlineTagOutput(Element holder, 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.

Parameters
holder:Element

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

the element for the enclosing doc comment

tag:DocTree

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

the tag

tagletWriter:TagletWriter

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

the taglet-writer used in this doclet

Returns:Content

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

the output for this tag

Annotations
@Override