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

Klasse UserTaglet

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.UserTaglet
Alle implementierten Schnittstellen:
Taglet
public final class UserTaglet extends Object implements Taglet
A taglet wrapper, allows the public taglet Taglet wrapped into an internal Taglet representation.

  • Verschachtelte Klassen - Übersicht

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

    Taglet.UnsupportedTagletOperationException

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    UserTaglet(Taglet t)
     

  • 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.
    Set<Taglet.Location>
    getAllowedLocations()
    Returns the set of allowed locations for a block tag handled by this taglet.
    Content
    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.
    String
    getName()
    Returns the name of this tag.
    boolean
    inConstructor()
    Indicates whether this Taglet can be used in constructor documentation.
    boolean
    inField()
    Indicates whether this Taglet can be used in field documentation.
    boolean
    inMethod()
    Indicates whether this Taglet can be used in method documentation.
    boolean
    inModule()
    Indicates whether this Taglet can be used in module documentation.
    boolean
    inOverview()
    Indicates whether this Taglet can be used in overview documentation.
    boolean
    inPackage()
    Indicates whether this Taglet can be used in package documentation.
    boolean
    inType()
    Indicates whether this Taglet can be used in type documentation (classes or interfaces).
    boolean
    isBlockTag()
    Indicates whether this Taglet represents a block tag.
    boolean
    isInlineTag()
    Indicates whether this Taglet represents an inline tag.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

  • Methodendetails

    • getAllowedLocations

      public Set<Taglet.Location> getAllowedLocations()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Returns the set of allowed locations for a block tag handled by this taglet.
      Angegeben von:
      getAllowedLocations in Schnittstelle Taglet
      Gibt zurück:
      the set of allowable locations

    • inField

      public boolean inField()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet can be used in field documentation.
      Angegeben von:
      inField in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet can be used in field documentation and false otherwise

    • inConstructor

      public boolean inConstructor()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet can be used in constructor documentation.
      Angegeben von:
      inConstructor in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet can be used in constructor documentation and false otherwise

    • inMethod

      public boolean inMethod()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet can be used in method documentation.
      Angegeben von:
      inMethod in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet can be used in method documentation and false otherwise

    • inOverview

      public boolean inOverview()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet can be used in overview documentation.
      Angegeben von:
      inOverview in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet can be used in overview documentation and false otherwise

    • inModule

      public boolean inModule()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet can be used in module documentation.
      Angegeben von:
      inModule in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet can be used in module documentation and false otherwise

    • inPackage

      public boolean inPackage()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet can be used in package documentation.
      Angegeben von:
      inPackage in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet can be used in package documentation and false otherwise

    • inType

      public boolean inType()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet can be used in type documentation (classes or interfaces).
      Angegeben von:
      inType in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet can be used in type documentation and false otherwise

    • isInlineTag

      public boolean isInlineTag()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet represents an inline tag.
      Angegeben von:
      isInlineTag in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet represents an inline tag and false otherwise

    • isBlockTag

      public boolean isBlockTag()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Indicates whether this Taglet represents a block tag.
      Angegeben von:
      isBlockTag in Schnittstelle Taglet
      Gibt zurück:
      true if this Taglet represents a block tag

    • getName

      public String getName()
      Beschreibung aus Schnittstelle kopiert: Taglet
      Returns the name of this tag.
      Angegeben von:
      getName in Schnittstelle Taglet
      Gibt zurück:
      the name of this tag

    • getInlineTagOutput

      public Content getInlineTagOutput(Element element, DocTree tag, TagletWriter writer)
      Beschreibung aus Schnittstelle kopiert: Taglet
      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
      Parameter:
      element - 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

    • getAllBlockTagOutput

      public Content getAllBlockTagOutput(Element holder, TagletWriter writer)
      Beschreibung aus Schnittstelle kopiert: Taglet
      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
      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