Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse TagletWriterImpl

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.TagletWriter

org.jdrupes.mdoclet.internal.doclets.formats.html.TagletWriterImpl

public class TagletWriterImpl
extends TagletWriter

The taglet writer that writes HTML.

Feldübersicht

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.TagletWriter

isFirstSentence

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
TagletWriterImpl(HtmlDocletWriter htmlWriter, boolean isFirstSentence)	Creates a taglet writer.
TagletWriterImpl(HtmlDocletWriter htmlWriter, boolean isFirstSentence, boolean inSummary)	Creates a taglet writer.
TagletWriterImpl(HtmlDocletWriter htmlWriter, org.jdrupes.mdoclet.internal.doclets.formats.html.TagletWriterImpl.Context context)	Creates a taglet writer.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected Content	codeTagOutput(Element element, LiteralTree tag)	Returns the output for a {@code …} tag.
Content	commentTagsToOutput(DocTree holder, List<? extends DocTree> tags)	Converts inline tags and text to content, expanding the inline tags along the way.
Content	commentTagsToOutput(Element holder, DocTree holderTag, List<? extends DocTree> tags, boolean isFirstSentence)	Converts inline tags and text to content, expanding the inline tags along the way.
Content	commentTagsToOutput(Element element, List<? extends DocTree> tags)	Converts inline tags and text to content, expanding the inline tags along the way.
BaseConfiguration	configuration()	Returns an instance of the configuration used for this doclet.
Content	deprecatedTagOutput(Element element)	Returns the output for a @deprecated tag.
protected TypeElement	getCurrentPageElement()	Returns the main type element of the current page or null for pages that don’t have one.
Content	getDocRootOutput()	Returns the output for a {@docRoot} tag.
HtmlDocletWriter	getHtmlWriter()
Element	getLinkedElement(Element referer, String signature)
Content	getOutputInstance()	Returns an instance of an output object.
Content	getParamHeader(ParamTaglet.ParamKind kind)	Returns the header for the @param tags.
Content	getThrowsHeader()	Returns the header for the @throws tag.
protected Content	indexTagOutput(Element element, IndexTree tag)	Returns the output for a {@index…} tag.
protected Content	invalidTagOutput(String summary, Optional<String> detail)	Returns the output for an invalid tag.
Content	linkTagOutput(Element element, LinkTree tag)	Returns the output for a {@link …} or {@linkplain …} tag.
protected Content	literalTagOutput(Element element, LiteralTree tag)	Returns the output for a {@literal …} tag.
Content	paramTagOutput(Element element, ParamTree paramTag, String paramName)	Returns the output for a @param tag.
Content	returnTagOutput(Element element, ReturnTree returnTag, boolean inline)	Returns the output for a @return tag.
Content	seeTagOutput(Element holder, List<? extends SeeTree> seeTags)	Returns the output for @see tags.
Content	simpleBlockTagOutput(Element element, List<? extends DocTree> simpleTags, String header)	Returns the output for a series of simple tags.
protected Content	snippetTagOutput(Element element, SnippetTree tag, StyledText content, String id, String lang)	Returns the output for a {@snippet …} tag.
Content	specTagOutput(Element holder, List<? extends SpecTree> specTags)	Returns the output for one or more @spec tags.
protected Content	systemPropertyTagOutput(Element element, SystemPropertyTree tag)	Returns the output for a {@systemProperty…} tag.
Content	throwsTagOutput(TypeMirror throwsType, Optional<Content> content)	Returns the output for a default @throws tag.
Content	valueTagOutput(VariableElement field, String constantVal, boolean includeLink)	Returns the output for a {@value} tag.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.TagletWriter

getBlockTagOutput, getInlineTagOutput

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

TagletWriterImpl

public TagletWriterImpl(HtmlDocletWriter htmlWriter,
 boolean isFirstSentence)

Creates a taglet writer.

Parameter:

htmlWriter - the HtmlDocletWriter for the page

isFirstSentence - true if this taglet writer is being used for a “first sentence” summary

TagletWriterImpl

public TagletWriterImpl(HtmlDocletWriter htmlWriter,
 boolean isFirstSentence,
 boolean inSummary)

Creates a taglet writer.

Parameter:

htmlWriter - the HtmlDocletWriter for the page

isFirstSentence - true if this taglet writer is being used for a “first sentence” summary, and false otherwise

inSummary - true if this taglet writer is being used for the content of a {@summary …} tag, and false otherwise

TagletWriterImpl

public TagletWriterImpl(HtmlDocletWriter htmlWriter,
 org.jdrupes.mdoclet.internal.doclets.formats.html.TagletWriterImpl.Context context)

Creates a taglet writer.

Parameter:

htmlWriter - the HtmlDocletWriter for the page

context - the enclosing context for any tags

Methodendetails

getOutputInstance

public Content getOutputInstance()

Beschreibung aus Klasse kopiert: TagletWriter

Returns an instance of an output object.

Angegeben von:

getOutputInstance in Klasse TagletWriter

Gibt zurück:

an instance of an output object

codeTagOutput

protected Content codeTagOutput(Element element,
 LiteralTree tag)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a {@code …} tag.

Angegeben von:

codeTagOutput in Klasse TagletWriter

Parameter:

element - The element that owns the doc comment

tag - the tag

Gibt zurück:

the output

indexTagOutput

protected Content indexTagOutput(Element element,
 IndexTree tag)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a {@index…} tag.

Angegeben von:

indexTagOutput in Klasse TagletWriter

Parameter:

element - The element that owns the doc comment

tag - the tag

Gibt zurück:

the output

getDocRootOutput

public Content getDocRootOutput()

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a {@docRoot} tag.

Angegeben von:

getDocRootOutput in Klasse TagletWriter

Gibt zurück:

the output

deprecatedTagOutput

public Content deprecatedTagOutput(Element element)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a @deprecated tag.

Angegeben von:

deprecatedTagOutput in Klasse TagletWriter

Parameter:

element - The element that owns the doc comment

Gibt zurück:

the output

linkTagOutput

public Content linkTagOutput(Element element,
 LinkTree tag)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a {@link …} or {@linkplain …} tag.

Angegeben von:

linkTagOutput in Klasse TagletWriter

Parameter:

element - The element that owns the doc comment

tag - the tag

Gibt zurück:

the output

literalTagOutput

protected Content literalTagOutput(Element element,
 LiteralTree tag)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a {@literal …} tag.

Angegeben von:

literalTagOutput in Klasse TagletWriter

Parameter:

element - The element that owns the doc comment

tag - the tag

Gibt zurück:

the output

getParamHeader

public Content getParamHeader(ParamTaglet.ParamKind kind)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the header for the @param tags.

Angegeben von:

getParamHeader in Klasse TagletWriter

Parameter:

kind - the kind of header that is required

Gibt zurück:

the header

paramTagOutput

public Content paramTagOutput(Element element,
 ParamTree paramTag,
 String paramName)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a @param tag.

Note we cannot rely on the name in the tag, because we might be inheriting the tag.

Angegeben von:

paramTagOutput in Klasse TagletWriter

Parameter:

element - The element that owns the doc comment

paramTag - the parameter to document

paramName - the name of the parameter

Gibt zurück:

the output

returnTagOutput

public Content returnTagOutput(Element element,
 ReturnTree returnTag,
 boolean inline)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a @return tag.

Angegeben von:

returnTagOutput in Klasse TagletWriter

Parameter:

element - the element that owns the doc comment

returnTag - the return tag to document

inline - whether this should be written as an inline instance or block instance

Gibt zurück:

the output

seeTagOutput

public Content seeTagOutput(Element holder,
 List<? extends SeeTree> seeTags)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for @see tags.

Angegeben von:

seeTagOutput in Klasse TagletWriter

Parameter:

holder - The element that owns the doc comment

seeTags - the list of tags

Gibt zurück:

the output

simpleBlockTagOutput

public Content simpleBlockTagOutput(Element element,
 List<? extends DocTree> simpleTags,
 String header)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a series of simple tags.

Angegeben von:

simpleBlockTagOutput in Klasse TagletWriter

Parameter:

element - The element that owns the doc comment

simpleTags - the list of simple tags

header - the header for the series of tags

Gibt zurück:

the output

snippetTagOutput

protected Content snippetTagOutput(Element element,
 SnippetTree tag,
 StyledText content,
 String id,
 String lang)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a {@snippet …} tag.

Angegeben von:

snippetTagOutput in Klasse TagletWriter

Parameter:

element - The element that owns the doc comment

tag - the snippet tag

id - the value of the id attribute, or null if not defined

lang - the value of the lang attribute, or null if not defined

Gibt zurück:

the output

getLinkedElement

public Element getLinkedElement(Element referer,
 String signature)

specTagOutput

public Content specTagOutput(Element holder,
 List<? extends SpecTree> specTags)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for one or more @spec tags.

Angegeben von:

specTagOutput in Klasse TagletWriter

Parameter:

holder - the element that owns the doc comment

specTags - the array of @spec tags.

Gibt zurück:

the output

systemPropertyTagOutput

protected Content systemPropertyTagOutput(Element element,
 SystemPropertyTree tag)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a {@systemProperty…} tag.

Angegeben von:

systemPropertyTagOutput in Klasse TagletWriter

Parameter:

element - the element that owns the doc comment

tag - the system property tag

Gibt zurück:

the output

getThrowsHeader

public Content getThrowsHeader()

Beschreibung aus Klasse kopiert: TagletWriter

Returns the header for the @throws tag.

Angegeben von:

getThrowsHeader in Klasse TagletWriter

Gibt zurück:

the header for the throws tag

throwsTagOutput

public Content throwsTagOutput(TypeMirror throwsType,
 Optional<Content> content)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a default @throws tag.

Angegeben von:

throwsTagOutput in Klasse TagletWriter

Parameter:

throwsType - the type that is thrown

content - the optional content to add as a description

Gibt zurück:

the output

valueTagOutput

public Content valueTagOutput(VariableElement field,
 String constantVal,
 boolean includeLink)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for a {@value} tag.

Angegeben von:

valueTagOutput in Klasse TagletWriter

Parameter:

field - the constant field that holds the value tag

constantVal - the constant value to document

includeLink - true if we should link the constant text to the constant field itself

Gibt zurück:

the output

invalidTagOutput

protected Content invalidTagOutput(String summary,
 Optional<String> detail)

Beschreibung aus Klasse kopiert: TagletWriter

Returns the output for an invalid tag.

The returned content uses special styling to highlight the problem. Depending on the presence of the detail string the method returns a plain text span or an expandable component.

Angegeben von:

invalidTagOutput in Klasse TagletWriter

Parameter:

summary - the single-line summary message

detail - the optional detail message which may contain preformatted text

Gibt zurück:

the output

commentTagsToOutput

public Content commentTagsToOutput(DocTree holder,
 List<? extends DocTree> tags)

Beschreibung aus Klasse kopiert: TagletWriter

Converts inline tags and text to content, expanding the inline tags along the way.

Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to block tags.

Angegeben von:

commentTagsToOutput in Klasse TagletWriter

Parameter:

holder - the tree that holds the documentation

tags - list of DocTree nodes containing text and inline tags (often alternating) present in the text of interest for this doc

Gibt zurück:

the generated content

commentTagsToOutput

public Content commentTagsToOutput(Element element,
 List<? extends DocTree> tags)

Beschreibung aus Klasse kopiert: TagletWriter

Converts inline tags and text to content, expanding the inline tags along the way.

Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to block tags.

Angegeben von:

commentTagsToOutput in Klasse TagletWriter

Parameter:

element - The element that owns the documentation

tags - list of DocTree nodes containing text and inline tags (often alternating) present in the text of interest for this doc

Gibt zurück:

the generated content

commentTagsToOutput

public Content commentTagsToOutput(Element holder,
 DocTree holderTag,
 List<? extends DocTree> tags,
 boolean isFirstSentence)

Beschreibung aus Klasse kopiert: TagletWriter

Converts inline tags and text to content, expanding the inline tags along the way.

Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to non-inline tags.

Angegeben von:

commentTagsToOutput in Klasse TagletWriter

Parameter:

holder - the element where comment resides

holderTag - the tag that holds the documentation

tags - array of text tags and inline tags (often alternating) present in the text of interest for this doc

isFirstSentence - true if this is the first sentence

Gibt zurück:

the generated content

configuration

public BaseConfiguration configuration()

Beschreibung aus Klasse kopiert: TagletWriter

Returns an instance of the configuration used for this doclet.

Angegeben von:

configuration in Klasse TagletWriter

Gibt zurück:

an instance of the configuration used for this doclet

getCurrentPageElement

protected TypeElement getCurrentPageElement()

Beschreibung aus Klasse kopiert: TagletWriter

Returns the main type element of the current page or null for pages that don’t have one.

Angegeben von:

getCurrentPageElement in Klasse TagletWriter

Gibt zurück:

the type element of the current page or null.

getHtmlWriter

public HtmlDocletWriter getHtmlWriter()