organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-04 13:05:31 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 7

ICU-23040 The real move from the JDK 8 APIs

Browse source 
ICUIgnoreTaglet was split in 3: ICUBugTaglet, ICUCategoryTaglet, ICUSummaryTaglet
because there is no more registration, should be one taglet per class.

Also moved making the Category a proper taglet.
This commit is contained in:
Mihai Nita 2025-03-19 14:17:39 -07:00
parent 57eaf4997a
commit 434ef42093
18 changed files with 425 additions and 303 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

101
icu4j/pom.xml
View file

@ -360,7 +360,7 @@
</plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.8.0</version>
<version>3.11.2</version>
<configuration>
<excludePackageNames>com.ibm.icu.impl,com.ibm.icu.impl.*,com.ibm.icu.dev.*,com.ibm.icu.samples,com.ibm.icu.samples.*</excludePackageNames>
<!--
@ -371,7 +371,8 @@
[ERROR] com\ibm\icu\util\ULocale.java:100: error: reference not found
[ERROR] * {@link com.ibm.icu.text.Collator}
-->
<doclint>html</doclint>
<!-- <doclint>html</doclint> -->
<doclint>none</doclint>
<notimestamp>true</notimestamp>
<nodeprecatedlist>true</nodeprecatedlist>
<quiet>true</quiet>
@ -385,29 +386,61 @@
<charset>UTF-8</charset>
<breakiterator>true</breakiterator>
<use>true</use>
<maxmemory>256m</maxmemory>
<minmemory>256m</minmemory>
<!-- <verbose>true</verbose> -->
<additionalJOptions>
<additionalJOption>-J-Dfile.encoding=UTF-8</additionalJOption>
</additionalJOptions>
<!--
Although the Maven Javadoc plugin claims that taglets are auto-detected,
it does not seem to work. But listing them explicitly does.
-->
<taglets>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUTaglet</tagletClass>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUBugTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUCategoryTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUDiscouragedTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUDraftTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUEnhancedTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUInternalTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUNewTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUNoteTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUObsoleteTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUProvisionalTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUStableTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUSummaryTaglet</tagletClass>
</taglet>
<taglet>
<tagletClass>com.ibm.icu.dev.tool.docs.ICUTestTaglet</tagletClass>
</taglet>
</taglets>
<tagletArtifacts>
<!-- To handle the ICU custom taglets (@icu, @draft, @stable, etc -->
<tagletArtifact>
<groupId>com.ibm.icu</groupId>
<artifactId>tools_taglets</artifactId>
<version>${project.version}</version>
</tagletArtifact>
</tagletArtifacts>
<tags>
<tag>
<name>category</name>
<placement>a</placement>
<head>Category:</head>
</tag>
</tags>
<!-- To handle the ICU custom taglets (@icu, @draft, @stable, etc -->
<tagletArtifact>
<groupId>com.ibm.icu</groupId>
<artifactId>tools_taglets</artifactId>
<version>${project.version}</version>
</tagletArtifact>
</configuration>
</plugin>
<plugin>
@ -633,7 +666,6 @@
</activation>
<modules>
<module>tools/build</module>
<module>tools/taglets</module>
</modules>
</profile>
@ -649,6 +681,9 @@
<activation>
<jdk>[9,)</jdk>
</activation>
<modules>
<module>tools/taglets</module>
</modules>
<build>
<plugins>
<plugin>
@ -771,4 +806,28 @@
</profile>
</profiles>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<reportSets>
<reportSet>
<id>aggregate</id>
<inherited>false</inherited>
<reports>
<report>aggregate</report>
</reports>
</reportSet>
<reportSet>
<id>default</id>
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
</project>

32
icu4j/tools/taglets/pom.xml
View file

@ -14,14 +14,28 @@
<artifactId>tools_taglets</artifactId>
<dependencies>
<dependency>
<groupId>jdk.tools</groupId>
<artifactId>jdk.tools</artifactId>
<version>1.8</version>
<scope>system</scope>
<systemPath>${JAVA_HOME}/lib/tools.jar</systemPath>
</dependency>
</dependencies>
<properties>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
<profiles>
<profile>
<id>newer_jdk</id>
<activation>
<jdk>[11,)</jdk>
</activation>
<build>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<release>11</release>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>

21
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUBugTaglet.java Normal file
View file

@ -0,0 +1,21 @@
// © 2025 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
package com.ibm.icu.dev.tool.docs;
import javax.lang.model.element.Element;
import com.sun.source.doctree.DocTree;
public class ICUBugTaglet extends ICUTaglet {
private static ICUTaglet singleton;
private static final String NAME = "bug";
public ICUBugTaglet() {
super(NAME, false);
}
public String toStringDocTree(DocTree tag, Element element) {
return null;
}
}

30
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUCategoryTaglet.java Normal file
View file

@ -0,0 +1,30 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import javax.lang.model.element.Element;
import com.sun.source.doctree.DocTree;
public class ICUCategoryTaglet extends ICUTaglet {
private static final String NAME = "category";
public ICUCategoryTaglet() {
super(NAME, false);
}
public String toStringDocTree(DocTree tag, Element element) {
String text = getText(tag, element);
if (text.length() == 0) {
System.err.println("Warning: empty category tag");
}
return "<dt><span class=\"simpleTagLabel\">Category:</span></dt><dd>" + text + "</dd>";
}
}

31
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUDiscouragedTaglet.java
View file

@ -1,25 +1,30 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import javax.lang.model.element.Element;
import com.sun.javadoc.Tag;
import com.sun.source.doctree.DocTree;
public class ICUDiscouragedTaglet extends ICUTaglet {
private static final String NAME = "discouraged";
public static void register(Map taglets) {
taglets.put(NAME, new ICUDiscouragedTaglet());
public ICUDiscouragedTaglet() {
super(NAME, false);
}
private ICUDiscouragedTaglet() {
super(NAME, MASK_DEFAULT);
}
public String toString(Tag tag) {
String text = tag.text();
public String toStringDocTree(DocTree tag, Element element) {
String text = getText(tag, element);
if (text.length() == 0) {
System.err.println("Error: empty discouraged tag ");
}
return "<dt><b><font color=red>Discouraged:</font></b></dt><dd>" + text + "</dd>";
}
return "<dt><span class=\"simpleTagLabel\" style=\"color:red\">Discouraged:</span></dt><dd>" + text + "</dd>";
}
}
}

29
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUDraftTaglet.java
View file

@ -1,25 +1,30 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import javax.lang.model.element.Element;
import com.sun.javadoc.Tag;
import com.sun.source.doctree.DocTree;
public class ICUDraftTaglet extends ICUTaglet {
private static final String NAME = "draft";
public static void register(Map taglets) {
taglets.put(NAME, new ICUDraftTaglet());
public ICUDraftTaglet() {
super(NAME, false);
}
private ICUDraftTaglet() {
super(NAME, MASK_DEFAULT);
}
public String toString(Tag tag) {
String text = tag.text();
public String toStringDocTree(DocTree tag, Element element) {
String text = getText(tag, element);
if (text.length() == 0) {
System.err.println("Warning: empty draft tag");
}
return STATUS + "<dd>Draft " + tag.text() + ".</dd>";
return STATUS + "<dd>Draft " + text + ".</dd>";
}
}
}

41
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUEnhancedTaglet.java
View file

@ -1,8 +1,17 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import javax.lang.model.element.Element;
import com.sun.javadoc.Tag;
import com.sun.source.doctree.DocTree;
/**
* This taglet should be used in the first line of the class description of classes
@ -20,29 +29,25 @@ import com.sun.javadoc.Tag;
* 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.
*/
public class ICUEnhancedTaglet extends ICUTaglet {
public class ICUEnhancedTaglet extends ICUTaglet {
private static final String NAME = "icuenhanced";
public static void register(Map taglets) {
taglets.put(NAME, new ICUEnhancedTaglet());
public ICUEnhancedTaglet() {
super(NAME, true);
}
private ICUEnhancedTaglet() {
super(NAME, MASK_DEFAULT_INLINE);
}
public String toStringDocTree(DocTree tag, Element element) {
String text = getText(tag, element).trim();
public String toString(Tag tag) {
String text = tag.text().trim();
boolean isClassDoc = tag.holder().isClass() || tag.holder().isInterface();
boolean isClassDoc = element.getKind().isClass() || element.getKind().isInterface();
if (isClassDoc && text.length() > 0) {
StringBuilder sb = new StringBuilder();
return sb.append("<strong><font color=red>[icu enhancement]</font></strong> ")
.append("ICU's replacement for <code>")
.append(text)
.append("</code>")
.toString();
return sb.append("<strong style=\"color:red\">[icu enhancement]</strong> ")
.append("ICU's replacement for <code>")
.append(text)
.append("</code>")
.toString();
}
return "";
}
}
}

26
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUIgnoreTaglet.java
View file

@ -1,26 +0,0 @@
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import com.sun.javadoc.Tag;
public class ICUIgnoreTaglet extends ICUTaglet {
private static ICUTaglet singleton;
public static void register(Map taglets) {
if (singleton == null) {
singleton = new ICUIgnoreTaglet();
}
taglets.put("bug", singleton);
taglets.put("test", singleton);
taglets.put("summary", singleton);
}
private ICUIgnoreTaglet() {
super(".ignore", MASK_DEFAULT);
}
public String toString(Tag tag) {
return null;
}
}

33
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUInternalTaglet.java
View file

@ -1,27 +1,34 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Locale;
import java.util.Map;
import com.sun.javadoc.Tag;
import javax.lang.model.element.Element;
import com.sun.source.doctree.DocTree;
public class ICUInternalTaglet extends ICUTaglet {
private static final String NAME = "internal";
public static void register(Map taglets) {
taglets.put(NAME, new ICUInternalTaglet());
public ICUInternalTaglet() {
super(NAME, false);
}
private ICUInternalTaglet() {
super(NAME, MASK_DEFAULT);
}
public String toString(Tag tag) {
if (tag.text().toLowerCase(Locale.US).indexOf("technology preview") >= 0) {
public String toStringDocTree(DocTree tag, Element element) {
String text = getText(tag, element);
if (text.toLowerCase(Locale.US).indexOf("technology preview") >= 0) {
return STATUS + "<dd><em>Technology Preview</em>. <font color='red'>" +
"This API is still in the early stages of development. Use at your own risk.</font></dd>";
"This API is still in the early stages of development. Use at your own risk.</font></dd>";
}
return STATUS + "<dd><em>Internal</em>. <font color='red'>" +
"This API is <em>ICU internal only</em>.</font></dd>";
"This API is <em>ICU internal only</em>.</font></dd>";
}
}
}

34
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUNewTaglet.java
View file

@ -1,8 +1,17 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import javax.lang.model.element.Element;
import com.sun.javadoc.Tag;
import com.sun.source.doctree.DocTree;
/**
* This taglet should be used in the first line of any icu-specific members in a class
@ -17,29 +26,26 @@ import com.sun.javadoc.Tag;
*/
public class ICUNewTaglet extends ICUTaglet {
private static final String NAME = "icu";
private static String ICU_LABEL = "<strong style=\"color:red\">[icu]</strong>";
public static void register(Map taglets) {
taglets.put(NAME, new ICUNewTaglet());
public ICUNewTaglet() {
super(NAME, true);
}
private ICUNewTaglet() {
super(NAME, MASK_DEFAULT_INLINE);
}
public String toString(Tag tag) {
String text = tag.text().trim();
public String toStringDocTree(DocTree tag, Element element) {
String text = getText(tag, element).trim();
StringBuilder sb = new StringBuilder();
if ("_usage_".equals(text)) {
return sb.append(" Methods, fields, and other functionality specific to ICU ")
.append("are labeled '" + ICU_LABEL + "'.</p>")
.toString();
.append("are labeled '" + ICU_LABEL + "'.")
.toString();
}
sb.append("<strong><font color=red>[icu]</font>");
sb.append("<strong style=\"color:red\">[icu]");
if (text.length() > 0) {
sb.append(" ").append(text);
}
sb.append("</strong>");
return sb.toString();
}
}
}

27
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUNoteTaglet.java
View file

@ -1,8 +1,17 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import javax.lang.model.element.Element;
import com.sun.javadoc.Tag;
import com.sun.source.doctree.DocTree;
/**
* This taglet should be used in class or member documentation, after the first line,
@ -12,15 +21,11 @@ import com.sun.javadoc.Tag;
public class ICUNoteTaglet extends ICUTaglet {
private static final String NAME = "icunote";
public static void register(Map taglets) {
taglets.put(NAME, new ICUNoteTaglet());
public ICUNoteTaglet() {
super(NAME, true);
}
private ICUNoteTaglet() {
super(NAME, MASK_DEFAULT_INLINE);
public String toStringDocTree(DocTree tag, Element element) {
return "<p><strong style=\"color:red\">[icu] Note:</strong> ";
}
public String toString(Tag tag) {
return "<p><strong><font color=red>[icu]</font> Note:</strong> ";
}
}
}

30
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUObsoleteTaglet.java
View file

@ -1,25 +1,31 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.text.BreakIterator;
import java.util.Locale;
import java.util.Map;
import com.sun.javadoc.Tag;
import javax.lang.model.element.Element;
import com.sun.source.doctree.DocTree;
public class ICUObsoleteTaglet extends ICUTaglet {
private static final String NAME = "obsolete";
public static void register(Map taglets) {
taglets.put(NAME, new ICUObsoleteTaglet());
public ICUObsoleteTaglet() {
super(NAME, false);
}
private ICUObsoleteTaglet() {
super(NAME, MASK_DEFAULT);
}
public String toString(Tag tag) {
public String toStringDocTree(DocTree tag, Element element) {
String text = getText(tag, element);
BreakIterator bi = BreakIterator.getSentenceInstance(Locale.US);
String text = tag.text();
bi.setText(text);
int first = bi.first();
int next = bi.next();
@ -27,7 +33,7 @@ public class ICUObsoleteTaglet extends ICUTaglet {
first = next = 0;
}
return STATUS + "<dd><em>Obsolete.</em> <font color='red'>Will be removed in " +
text.substring(first, next) + "</font>. " + text.substring(next) + "</dd>";
text.substring(first, next) + "</font>. " + text.substring(next) + "</dd>";
}
}
}

26
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUProvisionalTaglet.java
View file

@ -1,22 +1,26 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import javax.lang.model.element.Element;
import com.sun.javadoc.Tag;
import com.sun.source.doctree.DocTree;
public class ICUProvisionalTaglet extends ICUTaglet {
private static final String NAME = "provisional";
public static void register(Map taglets) {
taglets.remove(NAME); // override standard deprecated taglet
taglets.put(NAME, new ICUProvisionalTaglet());
public ICUProvisionalTaglet() {
super(NAME, false);
}
private ICUProvisionalTaglet() {
super(NAME, MASK_DEFAULT);
}
public String toString(Tag tag) {
public String toStringDocTree(DocTree tag, Element element) {
return null;
}
}
}

27
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUStableTaglet.java
View file

@ -1,26 +1,31 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import javax.lang.model.element.Element;
import com.sun.javadoc.Tag;
import com.sun.source.doctree.DocTree;
public class ICUStableTaglet extends ICUTaglet {
private static final String NAME = "stable";
public static void register(Map taglets) {
taglets.put(NAME, new ICUStableTaglet());
public ICUStableTaglet() {
super(NAME, false);
}
private ICUStableTaglet() {
super(NAME, MASK_DEFAULT);
}
public String toString(Tag tag) {
String text = tag.text();
public String toStringDocTree(DocTree tag, Element element) {
String text = getText(tag, element);
if (text.length() > 0) {
return STATUS + "<dd>Stable " + text + ".</dd>";
} else {
return STATUS + "<dd>Stable.</dd>";
}
}
}
}

21
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUSummaryTaglet.java Normal file
View file

@ -0,0 +1,21 @@
// © 2025 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
package com.ibm.icu.dev.tool.docs;
import javax.lang.model.element.Element;
import com.sun.source.doctree.DocTree;
public class ICUSummaryTaglet extends ICUTaglet {
private static ICUTaglet singleton;
private static final String NAME = "summary";
public ICUSummaryTaglet() {
super(NAME, false);
}
public String toStringDocTree(DocTree tag, Element element) {
return null;
}
}

138
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUTaglet.java
View file

@ -1,106 +1,100 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/**
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
*******************************************************************************
* Copyright (C) 2002-2016 International Business Machines Corporation *
* and others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import java.util.Map;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import com.sun.javadoc.Tag;
import com.sun.tools.doclets.internal.toolkit.taglets.Taglet;
import javax.lang.model.element.Element;
public abstract class ICUTaglet extends ICUTagletAdapter implements Taglet {
import com.sun.source.doctree.DocTree;
import com.sun.source.doctree.TextTree;
import com.sun.source.doctree.UnknownBlockTagTree;
import com.sun.source.doctree.UnknownInlineTagTree;
import com.sun.source.util.SimpleDocTreeVisitor;
import jdk.javadoc.doclet.Taglet;
public abstract class ICUTaglet implements Taglet {
protected final String name;
protected final int mask;
protected final boolean isInline;
protected static final int MASK_FIELD = 1;
protected static final int MASK_CONSTRUCTOR = 2;
protected static final int MASK_METHOD = 4;
protected static final int MASK_OVERVIEW = 8;
protected static final int MASK_PACKAGE = 16;
protected static final int MASK_TYPE = 32;
protected static final int MASK_INLINE = 64;
protected static final String STATUS = "<dt><span class=\"simpleTagLabel\">Status:</span></dt>";
protected static final int MASK_DEFAULT = 0x003f; // no inline
protected static final int MASK_DEFAULT_INLINE = 0x007f; // includes inline
protected static final int MASK_VALID = 0x007f;
public abstract String toStringDocTree(DocTree doc, Element element);
public static void register(Map taglets) {
ICUInternalTaglet.register(taglets);
ICUDraftTaglet.register(taglets);
ICUStableTaglet.register(taglets);
ICUProvisionalTaglet.register(taglets);
ICUObsoleteTaglet.register(taglets);
ICUIgnoreTaglet.register(taglets);
ICUNewTaglet.register(taglets);
ICUNoteTaglet.register(taglets);
ICUEnhancedTaglet.register(taglets);
ICUDiscouragedTaglet.register(taglets);
}
protected ICUTaglet(String name, int mask) {
protected ICUTaglet(String name, boolean isInline) {
this.name = name;
this.mask = mask & MASK_VALID;
this.isInline = isInline;
}
public boolean inField() {
return (mask & MASK_FIELD) != 0;
}
public boolean inConstructor() {
return (mask & MASK_CONSTRUCTOR) != 0;
}
public boolean inMethod() {
return (mask & MASK_METHOD) != 0;
}
public boolean inOverview() {
return (mask & MASK_OVERVIEW) != 0;
}
public boolean inPackage() {
return (mask & MASK_PACKAGE) != 0;
}
public boolean inType() {
return (mask & MASK_TYPE) != 0;
@Override
public Set<Location> getAllowedLocations() {
Set<Location> result = new HashSet<>();
result.add(Location.CONSTRUCTOR); // In the documentation for a constructor.
result.add(Location.FIELD); // In the documentation for a field.
result.add(Location.METHOD); // In the documentation for a method.
result.add(Location.MODULE); // In the documentation for a module.
result.add(Location.OVERVIEW); // In an Overview document.
result.add(Location.PACKAGE); // In the documentation for a package.
result.add(Location.TYPE); // In the documentation for a class, interface or enum.
return result;
}
public boolean isInlineTag() {
return (mask & MASK_INLINE) != 0;
return isInline;
}
public String getName() {
return name;
}
public String toString(Tag tag) {
return tag.text();
}
public String toString(Tag[] tags) {
if (!isInlineTag() && tags != null) {
if (tags.length > 1) {
@Override
public String toString(List<? extends DocTree> tags, Element element) {
if (tags != null) {
if (tags.size() > 1) {
String msg = "Should not have more than one ICU tag per element:\n";
for (int i = 0; i < tags.length; ++i) {
msg += " [" + i + "] " + tags[i] + "\n";
for (int i = 0; i < tags.size(); ++i) {
msg += " [" + i + "] " + tags.get(i) + "\n";
}
throw new IllegalStateException(msg);
} else if (tags.length > 0) {
return toString(tags[0]);
} else if (tags.size() > 0) {
return toStringDocTree(tags.get(0), element);
}
}
return null;
}
protected static final String STATUS = "<dt><b>Status:</b></dt>";
static String getText(DocTree dt, Element element) {
return dt.accept(new SimpleDocTreeVisitor<String, Void>() {
@Override
public String visitUnknownBlockTag(UnknownBlockTagTree node, Void p) {
for (DocTree dt : node.getContent()) {
return dt.accept(this, null);
}
return "";
}
static String ICU_LABEL = "<strong><font color=red>[icu]</font></strong>";
@Override
public String visitUnknownInlineTag(UnknownInlineTagTree node, Void p) {
for (DocTree dt : node.getContent()) {
return dt.accept(this, null);
}
return "";
}
@Override
public String visitText(TextTree node, Void p) {
return node.getBody();
}
}, null);
}
}

60
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUTagletAdapter.java
View file

@ -1,60 +0,0 @@
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2015, International Business Machines Corporation and *
* others. All Rights Reserved. *
*******************************************************************************
*/
package com.ibm.icu.dev.tool.docs;
import com.sun.javadoc.Doc;
import com.sun.javadoc.Tag;
import com.sun.tools.doclets.formats.html.markup.RawHtml;
import com.sun.tools.doclets.internal.toolkit.Content;
import com.sun.tools.doclets.internal.toolkit.taglets.Taglet;
import com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter;
/**
* The ICUTagletAdapter class is the abstract base class that adapts the ICUTaglet class to different implementations of the JavaDoc API.
* The methods in this class are meant to minimize the dual maintenance nature of supporting multiple JavaDoc APIs.
*
* This adapter supports the v8 JavaDoc API
*/
public abstract class ICUTagletAdapter implements Taglet {
public abstract String toString(Tag tag);
public abstract String toString(Tag[] tags);
public Content getTagletOutput(Tag tag, TagletWriter writer)
throws IllegalArgumentException {
// addContext doesn't except nulls so filter them out
String encodedText = toString(tag);
if(encodedText == null) return null;
Content out = writer.getOutputInstance();
out.addContent(new RawHtml(encodedText));
return out;
}
public Content getTagletOutput(Doc holder, TagletWriter writer)
throws IllegalArgumentException {
Content out = writer.getOutputInstance();
Tag[] tags = holder.tags(getName());
if (tags.length == 0) {
return null;
}
// addContext doesn't except nulls so filter them out
String encodedText = toString(tags[0]);
if(encodedText == null) return null;
out.addContent(new RawHtml(encodedText));
return out;
}
}

21
icu4j/tools/taglets/src/main/java/com/ibm/icu/dev/tool/docs/ICUTestTaglet.java Normal file
View file

@ -0,0 +1,21 @@
// © 2025 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
package com.ibm.icu.dev.tool.docs;
import javax.lang.model.element.Element;
import com.sun.source.doctree.DocTree;
public class ICUTestTaglet extends ICUTaglet {
private static ICUTaglet singleton;
private static final String NAME = "test";
public ICUTestTaglet() {
super(NAME, false);
}
public String toStringDocTree(DocTree tag, Element element) {
return null;
}
}