Class SeeTaglet
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.SeeTaglet
- All Implemented Interfaces:
InheritableTaglet
,Taglet
Deprecated.
A taglet that represents the @see 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
-
Field Summary
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetTagletOutput
(Doc holder, TagletWriter writer) Deprecated.Given aDoc
object, check if it holds any tags of this type.void
inherit
(DocFinder.Input input, DocFinder.Output output) Deprecated.Given anDocFinder.Output
object, set its values with the appropriate information to inherit documentation.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
getName, getTagletOutput, inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag
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
getName, getTagletOutput, inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, toString
-
Constructor Details
-
SeeTaglet
public SeeTaglet()Deprecated.
-
-
Method Details
-
inherit
Deprecated.Given anDocFinder.Output
object, set its values with the appropriate information to inherit documentation.- Specified by:
inherit
in interfaceInheritableTaglet
- Parameters:
input
- the input for documentation search.output
- the output for documentation search.
-
getTagletOutput
Deprecated.Given aDoc
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 interfaceTaglet
- Overrides:
getTagletOutput
in classBaseTaglet
- Parameters:
holder
- aDoc
object holding the custom tag.writer
- aTagletWriter
Taglet writer.- Returns:
- the TagletOutput representation of this
Tag
.
-