Class ICUEnhancedTaglet

java.lang.Object
com.ibm.icu.dev.tool.docs.ICUTaglet
com.ibm.icu.dev.tool.docs.ICUEnhancedTaglet
All Implemented Interfaces:
Taglet
public class ICUEnhancedTaglet extends ICUTaglet
This taglet should be used in the first line of the class description of classes that are enhancements of JDK classes that similar names and APIs. The text should provide the full package and name of the JDK class. A period should follow the tag. This puts an 'icu enhancement' message into the first line of the class docs, where it will also appear in the class summary.

Following this tag (and period), ideally in the first paragraph, the '@icu' tag should be used with the text '_label_' to generate the standard boilerplate about how that tag is used in the class docs. See ICUNewTaglet.

This cumbersome process is necessary because the javadoc code that handles taglets doesn't look at punctuation in the substitution text to determine when to end the first line, it looks in the original javadoc comment. So we need a tag to identify the related java class, then a period, then another tag.