Class InheritDocTaglet
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseInlineTaglet
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.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
- Author:
- Jamie Ho
-
-
Field Summary
Fields Modifier and Type Field Description static 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 theTag
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).-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseInlineTaglet
isInlineTag
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
getName, getTagletOutput, inMethod
-
-
-
-
Field Detail
-
INHERIT_DOC_INLINE_TAG
public static final 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
-
-
Method Detail
-
inField
public boolean inField()
Deprecated.Will return false because this inline tag may not appear in Fields.- Specified by:
inField
in interfaceTaglet
- Overrides:
inField
in classBaseTaglet
- Returns:
- false
-
inConstructor
public boolean inConstructor()
Deprecated.Will return false because this inline tag may not appear in Constructors.- Specified by:
inConstructor
in interfaceTaglet
- Overrides:
inConstructor
in classBaseTaglet
- Returns:
- false
-
inOverview
public boolean inOverview()
Deprecated.Will return false because this inline tag may not appear in Overview.- Specified by:
inOverview
in interfaceTaglet
- Overrides:
inOverview
in classBaseTaglet
- Returns:
- false
-
inPackage
public boolean inPackage()
Deprecated.Will return false because this inline tag may not appear in Packages.- Specified by:
inPackage
in interfaceTaglet
- Overrides:
inPackage
in classBaseTaglet
- Returns:
- false
-
inType
public boolean inType()
Deprecated.Will return true because this inline tag may appear in Type (Class).- Specified by:
inType
in interfaceTaglet
- Overrides:
inType
in classBaseTaglet
- Returns:
- true
-
getTagletOutput
public Content getTagletOutput(Tag tag, TagletWriter tagletWriter)
Deprecated.Given theTag
representation of this custom tag, return its string representation, which is output to the generated page.- Specified by:
getTagletOutput
in interfaceTaglet
- Overrides:
getTagletOutput
in classBaseTaglet
- Parameters:
tag
- theTag
representation of this custom tag.tagletWriter
- the taglet writer for output.- Returns:
- the Content representation of this
Tag
.
-
-