org.freehep.tools.doclet.tags
Class SeeTaglet

java.lang.Object
  org.freehep.tools.doclet.tags.AbstractExecutableMemberTaglet
      org.freehep.tools.doclet.tags.SeeTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class SeeTaglet

extends AbstractExecutableMemberTaglet

A taglet that represents the @see tag.

Since:

1.4

Author:

Jamie Ho

Source Code:

SeeTaglet.java

Field Summary

Fields inherited from class org.freehep.tools.doclet.tags.AbstractExecutableMemberTaglet

name

Constructor Summary

SeeTaglet()

Method Summary

boolean	inField() Return true if this Taglet is used in field documentation.
boolean	inOverview() Return true if this Taglet is used in overview documentation.
boolean	inPackage() Return true if this Taglet is used in package documentation.
boolean	inType() Return true if this Taglet is used in type documentation (classes or interfaces).
String	toString(com.sun.javadoc.Doc holder, HtmlStandardWriter writer) Given an array of Tags representing this custom tag, return its string representation.

Methods inherited from class org.freehep.tools.doclet.tags.AbstractExecutableMemberTaglet

getInheritedMethodDoc, getName, inConstructor, inMethod, isInlineTag, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SeeTaglet

public SeeTaglet()

Method Detail

inField

public boolean inField()

Return true if this Taglet is used in field documentation.

Specified by:

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

Overrides:

inField in class AbstractExecutableMemberTaglet

Returns:

true if this Taglet is used in field documentation and false otherwise.

inOverview

public boolean inOverview()

Return true if this Taglet is used in overview documentation.

Specified by:

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

Overrides:

inOverview in class AbstractExecutableMemberTaglet

Returns:

true if this Taglet is used in method documentation and false otherwise.

inPackage

public boolean inPackage()

Return true if this Taglet is used in package documentation.

Specified by:

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

Overrides:

inPackage in class AbstractExecutableMemberTaglet

Returns:

true if this Taglet is used in package documentation and false otherwise.

inType

public boolean inType()

Return true if this Taglet is used in type documentation (classes or interfaces).

Specified by:

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

Overrides:

inType in class AbstractExecutableMemberTaglet

Returns:

true if this Taglet is used in type documentation and false otherwise.

toString

public String toString(com.sun.javadoc.Doc holder,
                       HtmlStandardWriter writer)

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

Specified by:

toString in class AbstractExecutableMemberTaglet

Parameters:

holder - the ExecutableMemberDoc that holds this tag.

writer - the HtmlStandardWriter that will write this tag.

Returns:

the string representation of this Tag.