org.freehep.tools.doclet.tags
Class ThrowsTaglet

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

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class ThrowsTaglet

extends AbstractExecutableMemberTaglet

A taglet that represents the @throws tag.

Since:

1.4

Author:

Jamie Ho

Source Code:

ThrowsTaglet.java

Field Summary

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

name

Constructor Summary

ThrowsTaglet()

Method Summary

protected String	throwsTagsToString(com.sun.javadoc.ExecutableMemberDoc holder, com.sun.javadoc.ThrowsTag[] throwTags, HtmlStandardWriter writer, Set alreadyDocumented, boolean allowDups) Given an array of Tags representing this custom tag, return its string representation.
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, 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

ThrowsTaglet

public ThrowsTaglet()

Method Detail

toString

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

Given an array of Tags representing this custom tag, return its string representation. If possible, inherit the throws tags for undocumented declared exceptions.

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.

throwsTagsToString

protected String throwsTagsToString(com.sun.javadoc.ExecutableMemberDoc holder,
                                    com.sun.javadoc.ThrowsTag[] throwTags,
                                    HtmlStandardWriter writer,
                                    Set alreadyDocumented,
                                    boolean allowDups)

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

Parameters:

holder - the ExecutableMemberDoc that holds this tag.

throwTags - the array of ThrowsTags to convert.

writer - the HtmlStandardWriter that will write this tag.

alreadyDocumented - the set of exceptions that have already been documented.

allowDups - True if we allow duplicate throws tags to be documented.

Returns:

the string representation of this Tag.