Class BaseExecutableMemberTaglet

  • All Implemented Interfaces:
    Taglet
    Direct Known Subclasses:
    ReturnTaglet, ThrowsTaglet

    @Deprecated
    public abstract class BaseExecutableMemberTaglet
    extends BaseTaglet
    Deprecated.
    An abstract class for that implements the Taglet interface for tags in ExecutableMembers.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    Since:
    1.4
    Author:
    Jamie Ho
    • Constructor Detail

      • BaseExecutableMemberTaglet

        public BaseExecutableMemberTaglet()
        Deprecated.
    • Method Detail

      • inField

        public boolean inField()
        Deprecated.
        Return true if this Taglet is used in field documentation.
        Specified by:
        inField in interface Taglet
        Overrides:
        inField in class BaseTaglet
        Returns:
        true if this Taglet is used in field documentation and false otherwise.
      • inOverview

        public boolean inOverview()
        Deprecated.
        Return true if this Taglet is used in overview documentation.
        Specified by:
        inOverview in interface Taglet
        Overrides:
        inOverview in class BaseTaglet
        Returns:
        true if this Taglet is used in overview documentation and false otherwise.
      • inPackage

        public boolean inPackage()
        Deprecated.
        Return true if this Taglet is used in package documentation.
        Specified by:
        inPackage in interface Taglet
        Overrides:
        inPackage in class BaseTaglet
        Returns:
        true if this Taglet is used in package documentation and false otherwise.
      • inType

        public boolean inType()
        Deprecated.
        Return true if this Taglet is used in type documentation (classes or interfaces).
        Specified by:
        inType in interface Taglet
        Overrides:
        inType in class BaseTaglet
        Returns:
        true if this Taglet is used in type documentation and false otherwise.
      • isInlineTag

        public boolean isInlineTag()
        Deprecated.
        Return true if this Taglet is an inline tag.
        Specified by:
        isInlineTag in interface Taglet
        Overrides:
        isInlineTag in class BaseTaglet
        Returns:
        true if this Taglet is an inline tag and false otherwise.