be.kuleuven.cs.som.taglet
Class EffectTaglet

java.lang.Object
  be.kuleuven.cs.som.taglet.OOPTaglet
      be.kuleuven.cs.som.taglet.EffectTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class EffectTaglet
extends OOPTaglet

The EffectTaglet is an OOPTaglet, used to declare the effect of a method. It is used with the keyword "effect" and the header for the subsection will be "Effect:".

EffcetTaglet should be used on tags that are formatted as follows:

@effect   informally specified effect
          | formal part line 1
          | formal part line 2
          ...
 

The formal part can be left out. The output will be of the form:

Effect:

informally specified effect

formally:	formal part line 1
	formal part line 2

Author:

Koen Vanderkimpen

Constructor Summary

EffectTaglet()
Create a new EffectTaglet.

Method Summary

boolean	inConstructor() This tag can be used with constructors.
boolean	inField() This tag is not used with fields.
boolean	inMethod() This tag can be used with methods.
boolean	inOverview() This taag cannot be used in overview documentation.
boolean	inPackage() This tag cannot be used in package documentation.
boolean	inType() This tag cannot be used in general class or interface documentation.
boolean	isInlineTag() This tag is not an inline tag.
static void	register(java.util.Map tagletMap) Register this tag.

Methods inherited from class be.kuleuven.cs.som.taglet.OOPTaglet

getName, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EffectTaglet

public EffectTaglet()

Create a new EffectTaglet.

Method Detail

register

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

Register this tag. This is a method obligated by the Taglet API.

Parameters:

tagletMap - The map of String keys and Taglet values to register in.

See Also:

Taglet, OOPTaglet.register(java.util.Map,Object)

inField

public boolean inField()

This tag is not used with fields.

Returns:

false

See Also:

Taglet.inField()

inConstructor

public boolean inConstructor()

This tag can be used with constructors.

Returns:

true

See Also:

Taglet.inConstructor()

inMethod

public boolean inMethod()

This tag can be used with methods.

Returns:

true

See Also:

Taglet.inMethod()

inOverview

public boolean inOverview()

This taag cannot be used in overview documentation.

Returns:

false

See Also:

Taglet.inOverview()

inPackage

public boolean inPackage()

This tag cannot be used in package documentation.

Returns:

false

See Also:

Taglet.inPackage()

inType

public boolean inType()

This tag cannot be used in general class or interface documentation.

Returns:

false

See Also:

Taglet.inType()

isInlineTag

public boolean isInlineTag()

This tag is not an inline tag.

Returns:

false

See Also:

Taglet.isInlineTag()