public interface Taglet
register
that accepts a Map
as an
argument with the following signature:
public void register(Map map)This method should add an instance of the custom taglet to the map with the name of the taglet as the key. If overriding a taglet, to avoid a name conflict, the overridden taglet must be deleted from the map before an instance of the new taglet is added to the map.
It is recommended that the taglet throw an exception when it fails to register itself. The exception that it throws is up to the user.
Here are two sample taglets:
For more information on how to create your own Taglets, please see the Taglet Overview.
Modifier and Type | Method and Description |
---|---|
String |
getName()
Return the name of this custom tag.
|
boolean |
inConstructor()
Return true if this
Taglet
is used in constructor documentation. |
boolean |
inField()
Return true if this
Taglet
is used in field documentation. |
boolean |
inMethod()
Return true if this
Taglet
is used in method documentation. |
boolean |
inOverview()
Return true if this
Taglet
is used in overview documentation. |
boolean |
inPackage()
Return true if this
Taglet
is used in package documentation. |
boolean |
inType()
Return true if this
Taglet
is used in type documentation (classes or
interfaces). |
boolean |
isInlineTag()
Return true if this
Taglet
is an inline tag. |
String |
toString(com.sun.javadoc.Tag tag)
Given the
Tag representation of this custom
tag, return its string representation, which is output
to the generated page. |
String |
toString(com.sun.javadoc.Tag[] tags)
Given an array of
Tag s representing this custom
tag, return its string representation, which is output
to the generated page. |
boolean inField()
Taglet
is used in field documentation. Set to
false for inline tags.Taglet
is used in field documentation and false
otherwise.boolean inConstructor()
Taglet
is used in constructor documentation. Set to
false for inline tags.Taglet
is used in constructor documentation and false
otherwise.boolean inMethod()
Taglet
is used in method documentation. Set to
false for inline tags.Taglet
is used in method documentation and false
otherwise.boolean inOverview()
Taglet
is used in overview documentation. Set to
false for inline tags.Taglet
is used in method documentation and false
otherwise.boolean inPackage()
Taglet
is used in package documentation. Set to
false for inline tags.Taglet
is used in package documentation and false
otherwise.boolean inType()
Taglet
is used in type documentation (classes or
interfaces). Set to false for inline tags.Taglet
is used in type documentation and false
otherwise.boolean isInlineTag()
Taglet
is an inline tag. Return false otherwise.Taglet
is an inline tag and false otherwise.String getName()
String toString(com.sun.javadoc.Tag tag)
Tag
representation of this custom
tag, return its string representation, which is output
to the generated page.tag
- the Tag
representation of this custom tag.Tag
.String toString(com.sun.javadoc.Tag[] tags)
Tag
s representing this custom
tag, return its string representation, which is output
to the generated page. This method should
return null if this taglet represents an inline tag.tags
- the array of Tag
s representing of this custom tag.Tag
. Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2016, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.