org.jcoderz.phoenix.javadoc
Class JcoderzTaglet

java.lang.Object
  org.jcoderz.phoenix.javadoc.JcoderzTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

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

Author:

Michael Rumpf

Constructor Summary

JcoderzTaglet()

Method Summary

String	getName() The name of the taglet.
boolean	inConstructor() Will return true since xdoclet tag can be used in constructor documentation.
boolean	inField() Will return true since xdoclet can be used in field documentation.
boolean	inMethod() Will return true since xdoclet tag can be used in method documentation.
boolean	inOverview() Will return true since xdoclet tag can be used in method documentation.
boolean	inPackage() Will return true since xdoclet tag can be used in package documentation.
boolean	inType() Will return true since xdoclet tag can be used in type documentation (classes or interfaces).
boolean	isInlineTag() Will return false since xdoclet tags are not inline tags.
static void	register(Map tagletMap) Register this Taglet.
String	toString(Tag tag) Return empty string as the tags should not be shown in Javadoc.
String	toString(Tag[] tags) Return empty string as the tags should not be shown in Javadoc.

Methods inherited from class java.lang.Object

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

Constructor Detail

JcoderzTaglet

public JcoderzTaglet()

Method Detail

register

public static void register(Map tagletMap)

Register this Taglet.

Parameters:

tagletMap - the map to register this tag to.

getName

public String getName()

The name of the taglet.

Specified by:

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

Returns:

The name of the taglet.

inField

public boolean inField()

Will return true since xdoclet can be used in field documentation.

Specified by:

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

Returns:

true since xdoclet tags can be used in field documentation and false otherwise.

inConstructor

public boolean inConstructor()

Will return true since xdoclet tag can be used in constructor documentation.

Specified by:

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

Returns:

true since xdoclet tag can be used in constructor documentation and false otherwise.

inMethod

public boolean inMethod()

Will return true since xdoclet tag can be used in method documentation.

Specified by:

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

Returns:

true since xdoclet tag can be used in method documentation and false otherwise.

inOverview

public boolean inOverview()

Will return true since xdoclet tag can be used in method documentation.

Specified by:

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

Returns:

true since xdoclet tag can be used in overview documentation and false otherwise.

inPackage

public boolean inPackage()

Will return true since xdoclet tag can be used in package documentation.

Specified by:

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

Returns:

true since xdoclet tag can be used in package documentation and false otherwise.

inType

public boolean inType()

Will return true since xdoclet tag can be used in type documentation (classes or interfaces).

Specified by:

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

Returns:

true since xdoclet tag can be used in type documentation and false otherwise.

isInlineTag

public boolean isInlineTag()

Will return false since xdoclet tags are not inline tags.

Specified by:

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

Returns:

false since xdoclet tags are not inline tags.

toString

public String toString(Tag tag)

Return empty string as the tags should not be shown in Javadoc.

Specified by:

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

Parameters:

tag - the doclet tag encountered

Returns:

empty string.

toString

public String toString(Tag[] tags)

Return empty string as the tags should not be shown in Javadoc.

Specified by:

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

Parameters:

tags - the doclet tags encountered

Returns:

empty string.