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

Klasse SimpleTaglet

java.lang.Object

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

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

Alle implementierten Schnittstellen:

InheritableTaglet, Taglet

public class SimpleTaglet
extends BaseTaglet
implements InheritableTaglet

A custom single-argument block tag.

Verschachtelte Klassen - Übersicht

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

InheritableTaglet.Output

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

Taglet.UnsupportedTagletOperationException

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final boolean	enabled	Whether or not the taglet should generate output.
protected String	header	The header to output.

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

name, tagKind

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
SimpleTaglet(DocTree.Kind tagKind, String header, Set<Taglet.Location> locations)	Constructs a SimpleTaglet.
SimpleTaglet(DocTree.Kind tagKind, String header, Set<Taglet.Location> locations, boolean enabled)	Constructs a SimpleTaglet.
SimpleTaglet(String tagName, String header, String locations)	Constructs a SimpleTaglet.
SimpleTaglet(String tagName, String header, Set<Taglet.Location> locations)	Constructs a SimpleTaglet.
SimpleTaglet(String tagName, String header, Set<Taglet.Location> locations, boolean enabled)	Constructs a SimpleTaglet.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
Content	getAllBlockTagOutput(Element holder, TagletWriter writer)	Returns the content to be included in the generated output for all instances of block tags handled by this taglet.
InheritableTaglet.Output	inherit(Element owner, DocTree tag, boolean isFirstSentence, BaseConfiguration configuration)

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

accepts, getAllowedLocations, getInlineTagOutput, 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

getAllowedLocations, getInlineTagOutput, getName, inConstructor, inField, inMethod, inModule, inOverview, inPackage, inType, isBlockTag, isInlineTag

Felddetails

header

protected String header

The header to output.

enabled

protected final boolean enabled

Whether or not the taglet should generate output.

Standard tags like @author, @since, @version can be disabled by command-line options; custom tags created with -tag can be disabled with an X in the defining string.

Konstruktordetails

SimpleTaglet

public SimpleTaglet(String tagName,
 String header,
 String locations)

Constructs a SimpleTaglet.

Parameter:

tagName - the name of this tag

header - the header to output

locations - the possible locations that this tag can appear in The string can contain ‘p’ for package, ‘t’ for type, ‘m’ for method, ‘c’ for constructor and ‘f’ for field. See getLocations for the complete list.

SimpleTaglet

public SimpleTaglet(DocTree.Kind tagKind,
 String header,
 Set<Taglet.Location> locations)

Constructs a SimpleTaglet.

Parameter:

tagKind - the kind of this tag

header - the header to output

locations - the possible locations that this tag can appear in

SimpleTaglet

public SimpleTaglet(String tagName,
 String header,
 Set<Taglet.Location> locations)

Constructs a SimpleTaglet.

Parameter:

tagName - the name of this tag

header - the header to output

locations - the possible locations that this tag can appear in

SimpleTaglet

public SimpleTaglet(String tagName,
 String header,
 Set<Taglet.Location> locations,
 boolean enabled)

Constructs a SimpleTaglet.

Parameter:

tagName - the name of this tag

header - the header to output

locations - the possible locations that this tag can appear in

SimpleTaglet

public SimpleTaglet(DocTree.Kind tagKind,
 String header,
 Set<Taglet.Location> locations,
 boolean enabled)

Constructs a SimpleTaglet.

Parameter:

tagKind - the kind of this tag

header - the header to output

locations - the possible locations that this tag can appear in

Methodendetails

inherit

public InheritableTaglet.Output inherit(Element owner,
 DocTree tag,
 boolean isFirstSentence,
 BaseConfiguration configuration)

Angegeben von:

inherit in Schnittstelle InheritableTaglet

getAllBlockTagOutput

public Content getAllBlockTagOutput(Element holder,
 TagletWriter writer)

Beschreibung aus Klasse kopiert: BaseTaglet

Returns the content to be included in the generated output for all instances of block tags handled by this taglet.

Angegeben von:

getAllBlockTagOutput in Schnittstelle Taglet

Setzt außer Kraft:

getAllBlockTagOutput in Klasse BaseTaglet

Parameter:

holder - the element for the enclosing doc comment

writer - the taglet-writer used in this doclet

Gibt zurück:

the output for this tag