Package org.checkerframework.taglet
Class ManualTaglet
- java.lang.Object
-
- org.checkerframework.taglet.ManualTaglet
-
- All Implemented Interfaces:
jdk.javadoc.doclet.Taglet
public class ManualTaglet extends java.lang.Object implements jdk.javadoc.doclet.Taglet
A taglet for processing the@checker_framework.manual
javadoc block tag, which inserts references to the Checker Framework manual into javadoc.The
@checker_framework.manual
tag is used as follows:@checker_framework.manual #
expands to a top-level link to the Checker Framework manual@checker_framework.manual #anchor text
expands to a link with some text to a particular part of the manual
-
-
Constructor Summary
Constructors Constructor Description ManualTaglet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Set<jdk.javadoc.doclet.Taglet.Location>
getAllowedLocations()
java.lang.String
getName()
boolean
isInlineTag()
java.lang.String
toString(java.util.List<? extends com.sun.source.doctree.DocTree> tags, javax.lang.model.element.Element element)
-
-
-
Method Detail
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfacejdk.javadoc.doclet.Taglet
-
getAllowedLocations
public java.util.Set<jdk.javadoc.doclet.Taglet.Location> getAllowedLocations()
- Specified by:
getAllowedLocations
in interfacejdk.javadoc.doclet.Taglet
-
isInlineTag
public boolean isInlineTag()
- Specified by:
isInlineTag
in interfacejdk.javadoc.doclet.Taglet
-
toString
public java.lang.String toString(java.util.List<? extends com.sun.source.doctree.DocTree> tags, javax.lang.model.element.Element element)
- Specified by:
toString
in interfacejdk.javadoc.doclet.Taglet
-
-