Package org.apache.sis.internal.doclet
Class Module
java.lang.Object
org.apache.sis.internal.doclet.Taglet
org.apache.sis.internal.doclet.Module
- All Implemented Interfaces:
jdk.javadoc.doclet.Taglet
The
@module
tag. This tag expects no argument.- Since:
- 0.3
- Version:
- 1.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet
jdk.javadoc.doclet.Taglet.Location
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
format
(com.sun.source.doctree.DocTree tag, StringBuilder buffer) Given aDocTree
s representing this custom tag, appends its string representation.Set<jdk.javadoc.doclet.Taglet.Location>
Returns the set of locations in which this taglet may be used.getName()
Returns the name of this custom tag.boolean
Returnsfalse
since@module
is not an inline tag.Methods inherited from class org.apache.sis.internal.doclet.Taglet
getCurrentFile, init, printError, printWarning, text, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jdk.javadoc.doclet.Taglet
isBlockTag
-
Constructor Details
-
Module
public Module()Constructs a@module
taglet.
-
-
Method Details
-
getName
Returns the name of this custom tag.- Returns:
- "module".
-
getAllowedLocations
Returns the set of locations in which this taglet may be used.- Specified by:
getAllowedLocations
in interfacejdk.javadoc.doclet.Taglet
- Overrides:
getAllowedLocations
in classTaglet
- Returns:
- the set of locations in which this taglet may be used.
-
isInlineTag
public boolean isInlineTag()Returnsfalse
since@module
is not an inline tag.- Specified by:
isInlineTag
in interfacejdk.javadoc.doclet.Taglet
- Overrides:
isInlineTag
in classTaglet
- Returns:
- always
false
.
-
format
Given aDocTree
s representing this custom tag, appends its string representation.
-