Class DeprecatedTaglet

  • All Implemented Interfaces:
    Taglet

    @Deprecated
    public class DeprecatedTaglet
    extends BaseTaglet
    Deprecated.
    A taglet that represents the @deprecated tag.

    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.5
    Author:
    Jamie Ho
    • Constructor Detail

      • DeprecatedTaglet

        public DeprecatedTaglet()
        Deprecated.
    • Method Detail

      • getTagletOutput

        public Content getTagletOutput​(Doc holder,
                                       TagletWriter writer)
        Deprecated.
        Given a Doc object, check if it holds any tags of this type. If it does, return the string representing the output. If it does not, return null.
        Specified by:
        getTagletOutput in interface Taglet
        Overrides:
        getTagletOutput in class BaseTaglet
        Parameters:
        holder - a Doc object holding the custom tag.
        writer - a TagletWriter Taglet writer.
        Returns:
        the TagletOutput representation of this Tag.