be.kuleuven.cs.som.taglet
Class InvarTaglet

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

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class InvarTaglet
extends OOPTaglet

The invarTaglet is an OOPTaglet, used to declare the invariants of a class or field. It is used with the keyword "invar" and the header for the subsection will be "Invariant:".

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

@invar    informally specified invariant
          | formal part line 1
          | formal part line 2
          ...
 

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

Invariant:

informally specified invariant

formally:	formal part line 1
	formal part line 2

Author:

Koen Vanderkimpen

Constructor Summary

InvarTaglet()
Create a new EffectTaglet.

Method Summary

boolean	inConstructor() This tag cannot be used with constructors.
boolean	inField() This tag can be used with fields.
boolean	inMethod() This tag cannot 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 can 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

InvarTaglet

public InvarTaglet()

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 can be used with fields.

Returns:

true

See Also:

Taglet.inField()

inConstructor

public boolean inConstructor()

This tag cannot be used with constructors.

Returns:

false

See Also:

Taglet.inConstructor()

inMethod

public boolean inMethod()

This tag cannot be used with methods.

Returns:

false

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 can 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()