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

Klasse DocRootTaglet

java.lang.Object

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

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

Alle implementierten Schnittstellen:

Taglet

public class DocRootTaglet
extends BaseTaglet

An inline taglet representing {@docRoot}.

This taglet is used to get the relative path to the document’s root output directory.

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
DocRootTaglet()	Construct a new DocRootTaglet.

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

DocRootTaglet

public DocRootTaglet()

Construct a new DocRootTaglet.

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