org.freehep.tools.doclet.tags
Class AbstractExecutableMemberTaglet

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

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

Direct Known Subclasses:

ParamTaglet, ReturnTaglet, SeeTaglet, ThrowsTaglet

public abstract class AbstractExecutableMemberTaglet

extends Object

implements com.sun.tools.doclets.Taglet

An abstract class for Taglets in ExecutableMembers in the standard doclet.

Since:

1.4

Author:

Jamie Ho

Source Code:

AbstractExecutableMemberTaglet.java

Field Summary

protected String

name

Constructor Summary

AbstractExecutableMemberTaglet()

Method Summary

protected com.sun.javadoc.MethodDoc	getInheritedMethodDoc(com.sun.javadoc.MethodDoc method) Given a method, find a method that it overrides or implements so that we can inherit documentation.
String	getName() Return the name of this custom tag.
boolean	inConstructor() Return true if this Taglet is used in constructor documentation.
boolean	inField() Return true if this Taglet is used in field documentation.
boolean	inMethod() Return true if this Taglet is used in method 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).
boolean	isInlineTag() Return true if this Taglet is an inline tag.
abstract String	toString(com.sun.javadoc.Doc holder, HtmlStandardWriter writer)
String	toString(com.sun.javadoc.Tag tag) This method always returns "" because this Taglet requires more information to convert a Tag to a String.
String	toString(com.sun.javadoc.Tag[] tags) This method always returns "" because this Taglet requires more information to convert a Tag to a String.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Constructor Detail

AbstractExecutableMemberTaglet

public AbstractExecutableMemberTaglet()

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

Returns:

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

inField

public boolean inField()

Return true if this Taglet is used in field documentation.

Specified by:

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

Returns:

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

inMethod

public boolean inMethod()

Return true if this Taglet is used in method documentation.

Specified by:

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

Returns:

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

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

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

Returns:

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

isInlineTag

public boolean isInlineTag()

Return true if this Taglet is an inline tag.

Specified by:

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

Returns:

true if this Taglet is an inline tag and false otherwise.

getName

public String getName()

Return the name of this custom tag.

Specified by:

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

Returns:

the name of this custom tag.

toString

public String toString(com.sun.javadoc.Tag tag)

This method always returns "" because this Taglet requires more information to convert a Tag to a String.

Specified by:

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

Parameters:

tag - the Tag representation of this custom tag.

Returns:

an empty String.

toString

public String toString(com.sun.javadoc.Tag[] tags)

This method always returns "" because this Taglet requires more information to convert a Tag to a String.

Specified by:

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

Parameters:

tags - an array of Tags representing of this custom tag.

Returns:

an empty String.

getInheritedMethodDoc

protected com.sun.javadoc.MethodDoc getInheritedMethodDoc(com.sun.javadoc.MethodDoc method)

Given a method, find a method that it overrides or implements so that we can inherit documentation.

Parameters:

method - the method to inherit documentation from.

Returns:

an overriden or implemented method that we can inherit documentation from. Return if null no such method is found.

toString

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