org.freehep.tools.doclet.tags
Class ReturnTaglet

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

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class ReturnTaglet

extends AbstractExecutableMemberTaglet

A taglet that represents the @return tag.

Since:

1.4

Author:

Jamie Ho

Source Code:

ReturnTaglet.java

Field Summary

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

name

Constructor Summary

ReturnTaglet()

Method Summary

boolean	inConstructor() Return true if this Taglet is used in constructor documentation.
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, inField, inMethod, inOverview, inPackage, inType, isInlineTag, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturnTaglet

public ReturnTaglet()

Method Detail

inConstructor

public boolean inConstructor()

Return true if this Taglet is used in constructor documentation.

Specified by:

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

Overrides:

inConstructor in class AbstractExecutableMemberTaglet

Returns:

true if this Taglet is used in constructor 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.