org.jboss.weld.taglets

Class SeeIssueTaglet

java.lang.Object

org.jboss.weld.taglets.SeeIssueTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class SeeIssueTaglet
extends Object
implements com.sun.tools.doclets.Taglet

Author:

Kirill Gaevskii

Field Summary

Fields

Modifier and Type	Field and Description
static SeeIssueTaglet	INSTANCE

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of this taglet.
boolean	inConstructor() Return true if this taglet applicable in constructor documentation.
boolean	inField() Return true if this taglet applicable in field documentation.
boolean	inMethod() Return true if this taglet applicable in method documentation.
boolean	inOverview() Return true if this taglet applicable in overview documentation.
boolean	inPackage() Return true if this taglet applicable in package documentation.
boolean	inType() Return true if this taglet applicable in type documentation.
boolean	isInlineTag() Return true if this taglet is an inline tag.
static void	register(Map<String,com.sun.tools.doclets.Taglet> tagletMap) Register this Taglet.
String	toString(com.sun.javadoc.Tag tag) Given the tag representation of this custom tag, return its string representation, which is output to the generated page.
String	toString(com.sun.javadoc.Tag[] tags) Given an array of tags representing this custom tag, return its string representation, which is output to the generated page.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final SeeIssueTaglet INSTANCE

Method Detail

getName

public String getName()

Returns the name of this taglet.

Specified by:

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

Returns:

the name of this taglet.

inConstructor

public boolean inConstructor()

Return true if this taglet applicable in constructor documentation.

Specified by:

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

Returns:

is this taglet applicable in constructor documentation.

inField

public boolean inField()

Return true if this taglet applicable in field documentation.

Specified by:

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

Returns:

is this taglet applicable in field documentation.

inMethod

public boolean inMethod()

Return true if this taglet applicable in method documentation.

Specified by:

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

Returns:

is this taglet applicable in method documentation.

inOverview

public boolean inOverview()

Return true if this taglet applicable in overview documentation.

Specified by:

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

Returns:

is this taglet applicable in overview documentation.

inPackage

public boolean inPackage()

Return true if this taglet applicable in package documentation.

Specified by:

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

Returns:

is this taglet applicable in package documentation.

inType

public boolean inType()

Return true if this taglet applicable in type documentation.

Specified by:

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

Returns:

is this taglet applicable in type documentation.

isInlineTag

public boolean isInlineTag()

Return true if this taglet is an inline tag.

Specified by:

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

Returns:

is this taglet is an inline tag.

register

public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)

Register this Taglet.

Parameters:

tagletMap - the map to register this tag to.

toString

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

Given the tag representation of this custom tag, return its string representation, which is output to the generated page.

Specified by:

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

Parameters:

tag - - the Tag representation of this custom tag.

Returns:

the string representation of this tag.

toString

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

Given an array of tags representing this custom tag, return its string representation, which is output to the generated page.

Specified by:

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

Parameters:

tags - - the array of tags representing of this custom tag.

Returns:

the string representation of this tag.