com.webcohesion.enunciate.javac.javadoc

Class DefaultJavaDocTagHandler

java.lang.Object

com.webcohesion.enunciate.javac.javadoc.DefaultJavaDocTagHandler

All Implemented Interfaces:

JavaDocTagHandler

public class DefaultJavaDocTagHandler
extends Object
implements JavaDocTagHandler

Author:

Ryan Heaton

Field Summary

Fields

Modifier and Type	Field and Description
static DefaultJavaDocTagHandler	INSTANCE

Constructor Summary

Constructors

Constructor and Description
DefaultJavaDocTagHandler()

Method Summary

Methods

Modifier and Type	Method and Description
String	getTypeId() The id of the type of this tag handler.
String	onBlockTag(String tagName, String value, DecoratedElement context) What to do with a block JavaDoc tag.
String	onInlineTag(String tagName, String tagText, DecoratedElement context) What to do with an inline JavaDoc tag.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final DefaultJavaDocTagHandler INSTANCE

Constructor Detail

DefaultJavaDocTagHandler

public DefaultJavaDocTagHandler()

Method Detail

getTypeId

public String getTypeId()

Description copied from interface: JavaDocTagHandler

The id of the type of this tag handler.

Specified by:

getTypeId in interface JavaDocTagHandler

Returns:

The id of the type of this tag handler.

onInlineTag

public String onInlineTag(String tagName,
                 String tagText,
                 DecoratedElement context)

Description copied from interface: JavaDocTagHandler

What to do with an inline JavaDoc tag.

Specified by:

onInlineTag in interface JavaDocTagHandler

Parameters:

tagName - The tag name.

tagText - The tag text.

context - The context of the text.

Returns:

The text to replace the entire tag, or null for no replacement.

onBlockTag

public String onBlockTag(String tagName,
                String value,
                DecoratedElement context)

Description copied from interface: JavaDocTagHandler

What to do with a block JavaDoc tag.

Specified by:

onBlockTag in interface JavaDocTagHandler

Parameters:

tagName - The tag name.

value - the tag value.

context - the context of the text.

Returns:

The text to replace the value.