org.checkerframework.taglet

Class ManualTaglet

java.lang.Object

org.checkerframework.taglet.ManualTaglet

public class ManualTaglet
extends Object

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(Tag tag)
String	toString(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()

inConstructor

public boolean inConstructor()

inField

public boolean inField()

inMethod

public boolean inMethod()

inOverview

public boolean inOverview()

inPackage

public boolean inPackage()

inType

public boolean inType()

isInlineTag

public boolean isInlineTag()

toString

public String toString(Tag tag)

toString

public String toString(Tag[] tags)

register

public static void register(Map tagletMap)