Package org.checkerframework.taglet

Class ManualTaglet

java.lang.Object

org.checkerframework.taglet.ManualTaglet

All Implemented Interfaces:

jdk.javadoc.doclet.Taglet

public class ManualTaglet
extends 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

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet

jdk.javadoc.doclet.Taglet.Location

Constructor Summary

Constructors

Constructor	Description
ManualTaglet()

Method Summary

Modifier and Type	Method	Description
Set<jdk.javadoc.doclet.Taglet.Location>	getAllowedLocations()
String	getName()
boolean	isInlineTag()
String	toString(List<? extends com.sun.source.doctree.DocTree> tags, Element element)

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

init, isBlockTag

Constructor Details

ManualTaglet

public ManualTaglet()

Method Details

getName

public String getName()

Specified by:

getName in interface jdk.javadoc.doclet.Taglet

getAllowedLocations

public Set<jdk.javadoc.doclet.Taglet.Location> getAllowedLocations()

Specified by:

getAllowedLocations in interface jdk.javadoc.doclet.Taglet

isInlineTag

public boolean isInlineTag()

Specified by:

isInlineTag in interface jdk.javadoc.doclet.Taglet

toString

public String toString(List<? extends com.sun.source.doctree.DocTree> tags,
 Element element)

Specified by:

toString in interface jdk.javadoc.doclet.Taglet