Klasse ReturnTaglet
java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.BaseTaglet
org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.ReturnTaglet
- Alle implementierten Schnittstellen:
InheritableTaglet
,Taglet
A taglet that represents the @return and {@return } tags.
-
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
Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.BaseTaglet
name, tagKind
-
Konstruktorübersicht
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibunggetAllBlockTagOutput
(Element holder, TagletWriter writer) Returns the content to be included in the generated output for all instances of block tags handled by this taglet.getInlineTagOutput
(Element element, 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.inherit
(Element owner, DocTree tag, boolean isFirstSentence, BaseConfiguration configuration) boolean
Indicates whether this Taglet represents a block tag.Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.BaseTaglet
accepts, 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
getAllowedLocations, getName, inConstructor, inField, inMethod, inModule, inOverview, inPackage, inType, isInlineTag
-
Konstruktordetails
-
ReturnTaglet
public ReturnTaglet()
-
-
Methodendetails
-
isBlockTag
Beschreibung aus Schnittstelle kopiert:Taglet
Indicates whether this Taglet represents a block tag.- Angegeben von:
isBlockTag
in SchnittstelleTaglet
- Gibt zurück:
- true if this Taglet represents a block tag
-
inherit
public InheritableTaglet.Output inherit(Element owner, DocTree tag, boolean isFirstSentence, BaseConfiguration configuration) - Angegeben von:
inherit
in SchnittstelleInheritableTaglet
-
getInlineTagOutput
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 SchnittstelleTaglet
- Setzt außer Kraft:
getInlineTagOutput
in KlasseBaseTaglet
- Parameter:
element
- the element for the enclosing doc commenttag
- the tagwriter
- the taglet-writer used in this doclet- Gibt zurück:
- the output for this tag
-
getAllBlockTagOutput
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 SchnittstelleTaglet
- Setzt außer Kraft:
getAllBlockTagOutput
in KlasseBaseTaglet
- Parameter:
holder
- the element for the enclosing doc commentwriter
- the taglet-writer used in this doclet- Gibt zurück:
- the output for this tag
-