be.kuleuven.cs.som.taglet
Class OOPTaglet

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

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

Direct Known Subclasses:

EffectTaglet, InvarTaglet, NoteTaglet, PostTaglet, PreTaglet, ReturnTaglet

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

The OGPTaglet is a taglet to be used with the JavaDoc standard doclet. It supports tags specifically introduced in the course on object oriented programming, such as the pre tag and the effect tag. All those tags should subclass this class. The OOPTaglet generates the standard HTML as used by the standard doclet, with one adaptation: a formal part of the specification is possible, and will receive special attention.

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

@tag      informal explanation for the tag
          | formal part line 1
          | formal part line 2
          ...
 

The formal part can be left out.

Author:

Koen Vanderkimpen

Method Summary

java.lang.String	getName() Return the name of this OOPTaglet.
java.lang.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.
java.lang.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

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

Methods inherited from interface com.sun.tools.doclets.Taglet

inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag

Method Detail

getName

public java.lang.String getName()

Return the name of this OOPTaglet.

Specified by:

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

Returns:

the name of this OOPTaglet.

toString

public java.lang.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 Tag.

Returns:

the string representation of this 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, 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 the Tags.