org.openmrs.tools.doclet

Class ShouldTaglet

java.lang.Object

org.openmrs.tools.doclet.ShouldTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class ShouldTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet

Taglet for @should annotations.

Constructor Summary

Constructors

Constructor and Description
ShouldTaglet()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Return the name of this custom tag.
boolean	inConstructor() Will return true since @should can be used in constructor documentation.
boolean	inField() Will return false since @should cannot be used in field documentation.
boolean	inMethod() Will return true since @should can be used in method documentation.
boolean	inOverview() Will return true since @should can be used in method documentation.
boolean	inPackage() Will return false since @should cannot be used in package documentation.
boolean	inType() Will return true since @should can be used in type documentation (classes or interfaces).
boolean	isInlineTag() Will return false since @should is not an inline tag.
static void	register(java.util.Map tagletMap) Register this Taglet.
java.lang.String	toString(com.sun.javadoc.Tag tag) Given the Tag representation of this custom tag, return its string representation.
java.lang.String	toString(com.sun.javadoc.Tag[] tags) Given an array of Tags representing this custom tag, return its string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShouldTaglet

public ShouldTaglet()

Method Detail

getName

public java.lang.String getName()

Return the name of this custom tag.

Specified by:

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

inField

public boolean inField()

Will return false since @should cannot be used in field documentation.

Specified by:

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

Returns:

false since @should can be used in field documentation and true otherwise.

inConstructor

public boolean inConstructor()

Will return true since @should can be used in constructor documentation.

Specified by:

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

Returns:

true since @should can be used in constructor documentation and false otherwise.

inMethod

public boolean inMethod()

Will return true since @should can be used in method documentation.

Specified by:

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

Returns:

true since @should can be used in method documentation and false otherwise.

inOverview

public boolean inOverview()

Will return true since @should can be used in method documentation.

Specified by:

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

Returns:

true since @should can be used in overview documentation and false otherwise.

inPackage

public boolean inPackage()

Will return false since @should cannot be used in package documentation.

Specified by:

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

Returns:

false since @should cannot be used in package documentation and true otherwise.

inType

public boolean inType()

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

Specified by:

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

Returns:

true since @should can be used in type documentation and false otherwise.

isInlineTag

public boolean isInlineTag()

Will return false since @should is not an inline tag.

Specified by:

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

Returns:

false since @should is not an inline tag.

register

public static void register(java.util.Map tagletMap)

Register this Taglet.

Parameters:

tagletMap - the map to register this tag to.

toString

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

Given the Tag representation of this custom tag, return its string representation.

Specified by:

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

Parameters:

tag - the Tag representation of this custom tag.

toString

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

Given an array of Tags representing this custom tag, return its string representation.

Specified by:

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

Parameters:

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