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

Class InheritDocTaglet

  • All Implemented Interfaces:
    Taglet
    @Deprecated
public class InheritDocTaglet
extends BaseInlineTaglet
    Deprecated.
    An inline Taglet representing the inheritDoc tag. This tag should only be used with a method. It is used to inherit documentation from overriden and implemented methods.

    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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String INHERIT_DOC_INLINE_TAG
      Deprecated.
      The inline tag that would appear in the documentation if the writer wanted documentation to be inherited.

      • Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet

        name

    • Constructor Summary

      Constructors 
      Constructor Description
      InheritDocTaglet()
      Deprecated.
      Construct a new InheritDocTaglet.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Content getTagletOutput​(Tag tag, TagletWriter tagletWriter)
      Deprecated.
      Given the Tag representation of this custom tag, return its string representation, which is output to the generated page.
      boolean inConstructor()
      Deprecated.
      Will return false because this inline tag may not appear in Constructors.
      boolean inField()
      Deprecated.
      Will return false because this inline tag may not appear in Fields.
      boolean inOverview()
      Deprecated.
      Will return false because this inline tag may not appear in Overview.
      boolean inPackage()
      Deprecated.
      Will return false because this inline tag may not appear in Packages.
      boolean inType()
      Deprecated.
      Will return true because this inline tag may appear in Type (Class).
      private Content retrieveInheritedDocumentation​(TagletWriter writer, ProgramElementDoc ped, Tag holderTag, boolean isFirstSentence)
      Deprecated.
      Given a MethodDoc item, a Tag in the MethodDoc item and a String, replace all occurrences of @inheritDoc with documentation from it's superclass or superinterface.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.Taglet

        toString

    • Field Detail

      • INHERIT_DOC_INLINE_TAG

        public static final java.lang.String INHERIT_DOC_INLINE_TAG
        Deprecated.
        The inline tag that would appear in the documentation if the writer wanted documentation to be inherited.
        See Also:
        Constant Field Values

    • Constructor Detail

      • InheritDocTaglet

        public InheritDocTaglet()
        Deprecated.
        Construct a new InheritDocTaglet.

    • Method Detail

      • inField

        public boolean inField()
        Deprecated.
        Will return false because this inline tag may not appear in Fields.
        Specified by:
        inField in interface Taglet
        Overrides:
        inField in class BaseTaglet
        Returns:
        false

      • inConstructor

        public boolean inConstructor()
        Deprecated.
        Will return false because this inline tag may not appear in Constructors.
        Specified by:
        inConstructor in interface Taglet
        Overrides:
        inConstructor in class BaseTaglet
        Returns:
        false

      • inOverview

        public boolean inOverview()
        Deprecated.
        Will return false because this inline tag may not appear in Overview.
        Specified by:
        inOverview in interface Taglet
        Overrides:
        inOverview in class BaseTaglet
        Returns:
        false

      • inPackage

        public boolean inPackage()
        Deprecated.
        Will return false because this inline tag may not appear in Packages.
        Specified by:
        inPackage in interface Taglet
        Overrides:
        inPackage in class BaseTaglet
        Returns:
        false

      • inType

        public boolean inType()
        Deprecated.
        Will return true because this inline tag may appear in Type (Class).
        Specified by:
        inType in interface Taglet
        Overrides:
        inType in class BaseTaglet
        Returns:
        true

      • retrieveInheritedDocumentation

        private Content retrieveInheritedDocumentation​(TagletWriter writer,
                                               ProgramElementDoc ped,
                                               Tag holderTag,
                                               boolean isFirstSentence)
        Deprecated.
        Given a MethodDoc item, a Tag in the MethodDoc item and a String, replace all occurrences of @inheritDoc with documentation from it's superclass or superinterface.
        Parameters:
        writer - the writer that is writing the output.
        ped - the ProgramElementDoc that we are documenting.
        holderTag - the tag that holds the inheritDoc tag or null for type (class) docs.
        isFirstSentence - true if we only want to inherit the first sentence.

      • getTagletOutput

        public Content getTagletOutput​(Tag tag,
                               TagletWriter tagletWriter)
        Deprecated.
        Given the Tag representation of this custom tag, return its string representation, which is output to the generated page.
        Specified by:
        getTagletOutput in interface Taglet
        Overrides:
        getTagletOutput in class BaseTaglet
        Parameters:
        tag - the Tag representation of this custom tag.
        tagletWriter - the taglet writer for output.
        Returns:
        the Content representation of this Tag.