public interface Taglet
standard doclet
.
Custom taglets are used to handle custom tags in documentation
comments.
A custom taglet must implement this interface, and must have a public default constructor (i.e. a public constructor with no parameters), by which, the doclet will instantiate and register the custom taglet.
Modifier and Type | Interface | Description |
---|---|---|
static class |
Taglet.Location |
The kind of location in which a tag may be used.
|
Modifier and Type | Method | Description |
---|---|---|
Set<Taglet.Location> |
getAllowedLocations() |
Returns the set of locations in which a tag may be used.
|
String |
getName() |
Returns the name of the tag.
|
boolean |
isInlineTag() |
Indicates whether this taglet is for inline tags or not.
|
String |
toString(List<? extends com.sun.source.doctree.DocTree> tags) |
Returns the string representation of a series of instances of
this tag to be included in the generated output.
|
Set<Taglet.Location> getAllowedLocations()
boolean isInlineTag()
String getName()
String toString(List<? extends com.sun.source.doctree.DocTree> tags)
inline
tag} it will
be called once per instance of the tag, each time with a singleton list.
Otherwise, if this tag is a block tag, it will be called once per
comment, with a list of all the instances of the tag in the comment.tags
- the list of DocTree
containing one or more
instances of this 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, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-Debian+0-9b161-1