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

Klasse BaseTaglet

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.taglets.BaseTaglet
Alle implementierten Schnittstellen:
Taglet
Bekannte direkte Unterklassen:
CodeTaglet, DeprecatedTaglet, DocRootTaglet, IndexTaglet, InheritDocTaglet, LiteralTaglet, ParamTaglet, ReturnTaglet, SeeTaglet, SimpleTaglet, SnippetTaglet, SpecTaglet, SummaryTaglet, SystemPropertyTaglet, ThrowsTaglet, ValueTaglet
public class BaseTaglet extends Object implements Taglet
A base class that implements the Taglet interface.

  • Verschachtelte Klassen - Übersicht

    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 String
    name
     
    protected final DocTree.Kind
    tagKind
     

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    boolean
    accepts(DocTree tree)
    Returns whether or not this taglet accepts a DocTree node.
    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.
    DocTree.Kind
    getTagKind()
    Returns the kind of trees recognized by this taglet.
    final boolean
    inConstructor()
    Indicates whether this Taglet can be used in constructor documentation.
    final boolean
    inField()
    Indicates whether this Taglet can be used in field documentation.
    final boolean
    inMethod()
    Indicates whether this Taglet can be used in method documentation.
    final boolean
    inModule()
    Indicates whether this Taglet can be used in module documentation.
    final boolean
    inOverview()
    Indicates whether this Taglet can be used in overview documentation.
    final boolean
    inPackage()
    Indicates whether this Taglet can be used in package documentation.
    final boolean
    inType()
    Indicates whether this Taglet can be used in type documentation (classes or interfaces).
    final 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

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

    isBlockTag

  • Felddetails

  • 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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

    • 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

    • getTagKind

      public DocTree.Kind getTagKind()
      Returns the kind of trees recognized by this taglet.
      Gibt zurück:
      the kind of trees recognized by this taglet

    • accepts

      public boolean accepts(DocTree tree)
      Returns whether or not this taglet accepts a DocTree node.

      The taglet accepts a tree node if it has the same kind, and if the kind is UNKNOWN_BLOCK_TAG the same tag name.

      Parameter:
      tree - the tree node
      Gibt zurück:
      true if this taglet accepts this tree node

    • getInlineTagOutput

      public 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.
      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)
      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