org.codehaus.plexus.javadoc

Class AbstractPlexusTaglet

java.lang.Object

org.codehaus.plexus.javadoc.AbstractPlexusTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

Direct Known Subclasses:

PlexusComponentTaglet, PlexusConfigurationTaglet, PlexusRequirementTaglet

public abstract class AbstractPlexusTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet

Abstract Taglet for Plexus tags.

Version:

$Id$

See Also:

http://plexus.codehaus.org/guides/developer-guide/appendices/javadoc-tags-reference.html

Constructor Summary

Constructors

Constructor and Description
AbstractPlexusTaglet()

Method Summary

Modifier and Type	Method and Description
private static void	appendPlexusTag(java.lang.StringBuffer sb, javax.swing.text.MutableAttributeSet att) Append the wanted display in the javadoc.
private javax.swing.text.MutableAttributeSet	getAttributes(java.lang.String text)
abstract java.lang.String	getHeader()
java.lang.String	toString(com.sun.javadoc.Tag tag)
java.lang.String	toString(com.sun.javadoc.Tag[] tags)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.tools.doclets.Taglet

getName, inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag

Constructor Detail

AbstractPlexusTaglet

public AbstractPlexusTaglet()

Method Detail

toString

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

Specified by:

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

toString

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

Specified by:

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

getHeader

public abstract java.lang.String getHeader()

Returns:

the header to display

getAttributes

private javax.swing.text.MutableAttributeSet getAttributes(java.lang.String text)

Parameters:

text - the Tag text returned by Tag.text()

Returns:

a MutableAttributeSet or null if text was null

appendPlexusTag

private static void appendPlexusTag(java.lang.StringBuffer sb,
                                    javax.swing.text.MutableAttributeSet att)

Append the wanted display in the javadoc.

Parameters:

sb -

att -