Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets

Class ParamTaglet

  • All Implemented Interfaces:
    InheritableTaglet, Taglet
    @Deprecated
public class ParamTaglet
extends BaseTaglet
implements InheritableTaglet
    Deprecated.
    A taglet that represents the @param 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.4
    Author:
    Jamie Ho

    • Constructor Detail

      • ParamTaglet

        public ParamTaglet()
        Deprecated.
        Construct a ParamTaglet.

    • Method Detail

      • inherit

        public void inherit​(DocFinder.Input input,
                    DocFinder.Output output)
        Deprecated.
        Given an DocFinder.Output object, set its values with the appropriate information to inherit documentation.
        Specified by:
        inherit in interface InheritableTaglet
        Parameters:
        input - the input for documentation search.
        output - the output for documentation search.

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

      • inMethod

        public boolean inMethod()
        Deprecated.
        Return true if this Taglet is used in method documentation.
        Specified by:
        inMethod in interface Taglet
        Overrides:
        inMethod in class BaseTaglet
        Returns:
        true if this Taglet is used in method 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 method 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.

      • getTagletOutput

        public Content getTagletOutput​(Doc holder,
                               TagletWriter writer)
        Deprecated.
        Given an array of ParamTags,return its string representation.
        Specified by:
        getTagletOutput in interface Taglet
        Overrides:
        getTagletOutput in class BaseTaglet
        Parameters:
        holder - the member that holds the param tags.
        writer - the TagletWriter that will write this tag.
        Returns:
        the TagletOutput representation of these ParamTags.