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

Schnittstelle Taglet

Alle bekannten Unterschnittstellen:
InheritableTaglet
Alle bekannten Implementierungsklassen:
BaseTaglet, CodeTaglet, DeprecatedTaglet, DocRootTaglet, IndexTaglet, InheritDocTaglet, LiteralTaglet, ParamTaglet, ReturnTaglet, SeeTaglet, SimpleTaglet, SnippetTaglet, SpecTaglet, SummaryTaglet, SystemPropertyTaglet, ThrowsTaglet, UserTaglet, ValueTaglet
public interface Taglet
This is the taglet interface used internally within the doclet.

  • Verschachtelte Klassen - Übersicht

    Verschachtelte Klassen
    Modifizierer und Typ
    Schnittstelle
    Beschreibung
    static class 
    Taglet.UnsupportedTagletOperationException
     

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    Content
    getAllBlockTagOutput(Element owner, 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 owner, 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).
    default boolean
    isBlockTag()
    Indicates whether this Taglet represents a block tag.
    boolean
    isInlineTag()
    Indicates whether this Taglet represents an inline tag.

  • Methodendetails

    • getAllowedLocations

      Set<Taglet.Location> getAllowedLocations()
      Returns the set of allowed locations for a block tag handled by this taglet.
      Gibt zurück:
      the set of allowable locations

    • inField

      boolean inField()
      Indicates whether this Taglet can be used in field documentation.
      Gibt zurück:
      true if this Taglet can be used in field documentation and false otherwise

    • inConstructor

      boolean inConstructor()
      Indicates whether this Taglet can be used in constructor documentation.
      Gibt zurück:
      true if this Taglet can be used in constructor documentation and false otherwise

    • inMethod

      boolean inMethod()
      Indicates whether this Taglet can be used in method documentation.
      Gibt zurück:
      true if this Taglet can be used in method documentation and false otherwise

    • inOverview

      boolean inOverview()
      Indicates whether this Taglet can be used in overview documentation.
      Gibt zurück:
      true if this Taglet can be used in overview documentation and false otherwise

    • inModule

      boolean inModule()
      Indicates whether this Taglet can be used in module documentation.
      Gibt zurück:
      true if this Taglet can be used in module documentation and false otherwise

    • inPackage

      boolean inPackage()
      Indicates whether this Taglet can be used in package documentation.
      Gibt zurück:
      true if this Taglet can be used in package documentation and false otherwise

    • inType

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

    • isInlineTag

      boolean isInlineTag()
      Indicates whether this Taglet represents an inline tag.
      Gibt zurück:
      true if this Taglet represents an inline tag and false otherwise

    • isBlockTag

      default boolean isBlockTag()
      Indicates whether this Taglet represents a block tag.
      Gibt zurück:
      true if this Taglet represents a block tag

    • getName

      String getName()
      Returns the name of this tag.
      Gibt zurück:
      the name of this tag

    • getInlineTagOutput

      Content getInlineTagOutput(Element owner, DocTree tag, TagletWriter writer) throws Taglet.UnsupportedTagletOperationException
      Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.
      Parameter:
      owner - 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
      Löst aus:
      Taglet.UnsupportedTagletOperationException - if the method is not supported by the taglet

    • getAllBlockTagOutput

      Content getAllBlockTagOutput(Element owner, TagletWriter writer) throws Taglet.UnsupportedTagletOperationException
      Returns the content to be included in the generated output for all instances of block tags handled by this taglet.
      Parameter:
      owner - the element for the enclosing doc comment
      writer - the taglet-writer used in this doclet
      Gibt zurück:
      the output for this tag
      Löst aus:
      Taglet.UnsupportedTagletOperationException - if the method is not supported by the taglet