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

Class ReturnTaglet

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseExecutableMemberTaglet
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.ReturnTaglet
All Implemented Interfaces:
InheritableTaglet, Taglet
@Deprecated public class ReturnTaglet extends BaseExecutableMemberTaglet implements InheritableTaglet
Deprecated.
A taglet that represents the @return 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

  • Constructor Details

    • ReturnTaglet

      public ReturnTaglet()
      Deprecated.

  • Method Details

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

    • inConstructor

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

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