org.freehep.tools.doclet.tags
Class ParamTaglet

java.lang.Object
  |
  +--org.freehep.tools.doclet.tags.AbstractExecutableMemberTaglet
        |
        +--org.freehep.tools.doclet.tags.ParamTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class ParamTaglet

extends AbstractExecutableMemberTaglet

A taglet that represents the @param tag.

Since:

1.4

Author:

Jamie Ho

Field Summary

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

name

Constructor Summary

ParamTaglet()

Method Summary

protected String	paramTagsToString(com.sun.javadoc.ExecutableMemberDoc holder, com.sun.javadoc.ParamTag[] paramTags, HtmlStandardWriter writer, Map rankMap, Map nameMap, Set alreadyDocumented) 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 ParamTags,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

ParamTaglet

public ParamTaglet()

Method Detail

toString

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

Given an array of ParamTags,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 these ParamTags.

paramTagsToString

protected String paramTagsToString(com.sun.javadoc.ExecutableMemberDoc holder,
                                   com.sun.javadoc.ParamTag[] paramTags,
                                   HtmlStandardWriter writer,
                                   Map rankMap,
                                   Map nameMap,
                                   Set alreadyDocumented)

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

Parameters:

holder - the ExecutableMemberDoc that holds this tag.

paramTags - the array of ParamTags to convert.

writer - the HtmlStandardWriter that will write this tag.

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

rankMap - a Map which holds ordering information about the parameters.

nameMap - a Map which holds a mapping of a rank of a parameter to its name. This is used to ensure that the right name is used when parameter documentation is inherited.

Returns:

the string representation of this Tag.