Class ICUNoteTaglet

java.lang.Object

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

com.ibm.icu.dev.tool.docs.ICUNoteTaglet

All Implemented Interfaces:

Taglet

public class ICUNoteTaglet
extends ICUTaglet

This taglet should be used in class or member documentation, after the first line, where the behavior of the ICU method or class has notable differences from its JDK counterpart. It starts a new paragraph and generates an '[icu] Note:' header.

Nested Class Summary

Nested classes/interfaces inherited from interface Taglet

Taglet.Location

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	NAME

Fields inherited from class ICUTaglet

isInline, name, STATUS

Constructor Summary

Constructors

Constructor	Description
ICUNoteTaglet()

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

Constructor Details

ICUNoteTaglet

public ICUNoteTaglet()

Method Details

toStringDocTree

public String toStringDocTree(DocTree tag,
 Element element)

Specified by:

toStringDocTree in class ICUTaglet