Class ICUNewTaglet

java.lang.Object

com.ibm.icu.dev.tool.docs.ICUTaglet

com.ibm.icu.dev.tool.docs.ICUNewTaglet

All Implemented Interfaces:

Taglet

public class ICUNewTaglet
extends ICUTaglet

This taglet should be used in the first line of any icu-specific members in a class that is an enhancement of a JDK class (see ICUEnhancedTaglet). It generates the '[icu]' marker followed by the <strong> text, if any. This does not start or end a paragraph or provide additional leading or trailing punctuation such as spaces or periods.

Note: if the text is '_usage_' (without quotes) this spits out a boilerplate message describing the meaning of the '[icu]' tag. This should be done in the first paragraph of the class docs of any class containing '@icu' tags.

Nested Class Summary

Nested classes/interfaces inherited from interface Taglet

Taglet.Location

Field Summary

Fields

Modifier and Type	Field	Description
private static String	ICU_LABEL
private static final String	NAME

Fields inherited from class ICUTaglet

isInline, name, STATUS

Constructor Summary

Constructors

Constructor	Description
ICUNewTaglet()

Method Summary

Modifier and Type	Method	Description
String	toStringDocTree(DocTree tag, Element element)

Methods inherited from class ICUTaglet

getAllowedLocations, getName, getText, isInlineTag, toString

Methods inherited from class Object

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

Methods inherited from interface Taglet

init

Field Details

NAME

private static final String NAME

See Also:

• Constant Field Values

ICU_LABEL

private static String ICU_LABEL

Constructor Details

ICUNewTaglet

public ICUNewTaglet()

Method Details

toStringDocTree

public String toStringDocTree(DocTree tag,
 Element element)

Specified by:

toStringDocTree in class ICUTaglet