org.checkerframework.javacutil.dist

Class ManualTaglet

java.lang.Object

org.checkerframework.javacutil.dist.ManualTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class ManualTaglet
extends Object
implements com.sun.tools.doclets.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 and Description
ManualTaglet()

Method Summary

Modifier and Type	Method and Description
String	getName()
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
static void	register(Map tagletMap)
String	toString(com.sun.javadoc.Tag tag)
String	toString(com.sun.javadoc.Tag[] tags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManualTaglet

public ManualTaglet()

Method Detail

getName

public String getName()

Specified by:

getName in interface com.sun.tools.doclets.Taglet

inConstructor

public boolean inConstructor()

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

inField

public boolean inField()

Specified by:

inField in interface com.sun.tools.doclets.Taglet

inMethod

public boolean inMethod()

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

inOverview

public boolean inOverview()

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

inPackage

public boolean inPackage()

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

inType

public boolean inType()

Specified by:

inType in interface com.sun.tools.doclets.Taglet

isInlineTag

public boolean isInlineTag()

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet

toString

public String toString(com.sun.javadoc.Tag tag)

Specified by:

toString in interface com.sun.tools.doclets.Taglet

toString

public String toString(com.sun.javadoc.Tag[] tags)

Specified by:

toString in interface com.sun.tools.doclets.Taglet

register

public static void register(Map tagletMap)