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

Klasse ValueTaglet

java.lang.Object

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

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

Alle implementierten Schnittstellen:

Taglet

public class ValueTaglet
extends BaseTaglet

An inline taglet representing the value tag.

This tag should only be used with constant fields that have a value. It is used to access the value of constant fields. This inline tag has an optional field name parameter. If the name is specified, the constant value is retrieved from the specified field. A link is also created to the specified field. If a name is not specified, the value is retrieved for the field that the inline tag appears on. The name is specified in the following format: [fully qualified class name]#[constant field name].

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.Taglet

Taglet.UnsupportedTagletOperationException

Feldübersicht

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

name, tagKind

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ValueTaglet()	Construct a new ValueTaglet.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Content	getInlineTagOutput(Element holder, DocTree tag, TagletWriter writer)	Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.

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

accepts, getAllBlockTagOutput, getAllowedLocations, getName, getTagKind, inConstructor, inField, inMethod, inModule, inOverview, inPackage, inType, isInlineTag

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.Taglet

isBlockTag

Konstruktordetails

ValueTaglet

public ValueTaglet()

Construct a new ValueTaglet.

Methodendetails

getInlineTagOutput

public Content getInlineTagOutput(Element holder,
 DocTree tag,
 TagletWriter writer)

Beschreibung aus Klasse kopiert: BaseTaglet

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

Angegeben von:

getInlineTagOutput in Schnittstelle Taglet

Setzt außer Kraft:

getInlineTagOutput in Klasse BaseTaglet

Parameter:

holder - the element for the enclosing doc comment

tag - the tag

writer - the taglet-writer used in this doclet

Gibt zurück:

the output for this tag