From 3b2bd4b19dbcdb4cf1b0d94a1c4968d586b639ab Mon Sep 17 00:00:00 2001 From: Mihai Nita Date: Sun, 16 Feb 2025 15:05:04 -0800 Subject: [PATCH] ICU-22921 Fix some javadoc issues --- .../com/ibm/icu/message2/FormattedPlaceholder.java | 1 + .../java/com/ibm/icu/message2/FormatterFactory.java | 2 +- .../java/com/ibm/icu/message2/MessageFormatter.java | 8 ++++---- .../com/ibm/icu/number/NumberRangeFormatter.java | 2 +- .../java/com/ibm/icu/text/DateIntervalFormat.java | 6 +++--- .../src/main/java/com/ibm/icu/text/SpoofChecker.java | 4 ++-- .../main/java/com/ibm/icu/util/BasicTimeZone.java | 12 ++++++------ .../src/main/java/com/ibm/icu/util/MeasureUnit.java | 4 ++-- 8 files changed, 20 insertions(+), 19 deletions(-) diff --git a/icu4j/main/core/src/main/java/com/ibm/icu/message2/FormattedPlaceholder.java b/icu4j/main/core/src/main/java/com/ibm/icu/message2/FormattedPlaceholder.java index 4c4b17693e0..6037691072b 100644 --- a/icu4j/main/core/src/main/java/com/ibm/icu/message2/FormattedPlaceholder.java +++ b/icu4j/main/core/src/main/java/com/ibm/icu/message2/FormattedPlaceholder.java @@ -26,6 +26,7 @@ public class FormattedPlaceholder { * @param inputValue the original value to be formatted. * @param formattedValue the result of formatting the placeholder. * @param directionality the directionality of the formatted placeholder. + * @param isolate true if the placeholder should be considered a bidi isolate. * * @internal ICU 72 technology preview * @deprecated This API is for ICU internal use only. diff --git a/icu4j/main/core/src/main/java/com/ibm/icu/message2/FormatterFactory.java b/icu4j/main/core/src/main/java/com/ibm/icu/message2/FormatterFactory.java index 4ece12344b0..b315b586c14 100644 --- a/icu4j/main/core/src/main/java/com/ibm/icu/message2/FormatterFactory.java +++ b/icu4j/main/core/src/main/java/com/ibm/icu/message2/FormatterFactory.java @@ -23,7 +23,7 @@ public interface FormatterFactory { * @param locale the locale to use for formatting. * @param fixedOptions the options to use for formatting. The keys and values are function dependent. * @return the formatter. - * @throws IllegalArgumentException + * @throws IllegalArgumentException in case there is a problem with the arguments. * * @internal ICU 72 technology preview * @deprecated This API is for technology preview only. diff --git a/icu4j/main/core/src/main/java/com/ibm/icu/message2/MessageFormatter.java b/icu4j/main/core/src/main/java/com/ibm/icu/message2/MessageFormatter.java index 940f98492ab..967e7fce709 100644 --- a/icu4j/main/core/src/main/java/com/ibm/icu/message2/MessageFormatter.java +++ b/icu4j/main/core/src/main/java/com/ibm/icu/message2/MessageFormatter.java @@ -51,7 +51,7 @@ import java.util.Map; * @Test * public void test() { * final Locale enGb = Locale.forLanguageTag("en-GB"); - * Map arguments = new HashMap<>(); + * Map<String, Object> arguments = new HashMap<>(); * arguments.put("name", "John"); * arguments.put("exp", new Date(2023 - 1900, 2, 27, 19, 42, 51)); // March 27, 2023, 7:42:51 PM * @@ -101,7 +101,7 @@ import java.util.Map; * + " 1 {{You have one notification.}}\n" * + " * {{You have {$count} notifications.}}\n"; * final Locale enGb = Locale.forLanguageTag("en-GB"); - * Map arguments = new HashMap<>(); + * Map<String, Object> arguments = new HashMap<>(); * * MessageFormatter mf2 = MessageFormatter.builder() * .setPattern(message) @@ -311,7 +311,7 @@ public class MessageFormatter { * depending on this setting.

* *

Used in conjunction with the - * {@link MessageFormatter.Builder#setErrorHandlingBehavior(ErrorHandlingBehavior)} method.

+ * {@link MessageFormatter.Builder#setErrorHandlingBehavior(MessageFormatter.ErrorHandlingBehavior)} method.

* * @internal ICU 76 technology preview * @deprecated This API is for technology preview only. @@ -343,7 +343,7 @@ public class MessageFormatter { * described in the MessageFormat 2 specification.

* *

Used in conjunction with the - * {@link MessageFormatter.Builder#setBidiIsolation(BidiIsolation)} method.

+ * {@link MessageFormatter.Builder#setBidiIsolation(MessageFormatter.BidiIsolation)} method.

* * @internal ICU 77 technology preview * @deprecated This API is for technology preview only. diff --git a/icu4j/main/core/src/main/java/com/ibm/icu/number/NumberRangeFormatter.java b/icu4j/main/core/src/main/java/com/ibm/icu/number/NumberRangeFormatter.java index e36e82ebeb1..8fc2d19d148 100644 --- a/icu4j/main/core/src/main/java/com/ibm/icu/number/NumberRangeFormatter.java +++ b/icu4j/main/core/src/main/java/com/ibm/icu/number/NumberRangeFormatter.java @@ -20,7 +20,7 @@ import com.ibm.icu.util.ULocale; * .locale(ULocale.UK) * .formatRange(750, 1.2) * .toString(); - * // => "750 m - 1.2 km" + * // => "750 m - 1.2 km" * *

* Like NumberFormatter, NumberRangeFormatter instances (i.e., LocalizedNumberRangeFormatter diff --git a/icu4j/main/core/src/main/java/com/ibm/icu/text/DateIntervalFormat.java b/icu4j/main/core/src/main/java/com/ibm/icu/text/DateIntervalFormat.java index d73fbe38e83..7dc79a8ed3b 100644 --- a/icu4j/main/core/src/main/java/com/ibm/icu/text/DateIntervalFormat.java +++ b/icu4j/main/core/src/main/java/com/ibm/icu/text/DateIntervalFormat.java @@ -571,7 +571,7 @@ public class DateIntervalFormat extends UFormat { * getInstance(String skeleton, ULocale locale) * * - *

Example code:

+ *

Example code:

* * 
      * import java.util.Date;
@@ -698,7 +698,7 @@ public class DateIntervalFormat extends UFormat {
      * getInstance(String skeleton, ULocale locale, DateIntervalInfo dtitvinf)
      *
      * 
-     * 
Example code:

+     * 
Example code:

      *
      * 
      * final Date date[] = {
@@ -724,7 +724,7 @@ public class DateIntervalFormat extends UFormat {
      * dtitvinf.setFallbackIntervalPattern("{0} ~~~ {1}");
      * // Get the DateIntervalFormat with the custom pattern
      * for (String skeleton:skeletons){
-     *     for (int i=0;i<2;i++) {
+     *     for (int i=0;i<2;i++) {
      *         System.out.printf("%-15s%-35s%-35s", skeleton,date[i].toString(), date[i+1].toString());
      *         DateIntervalFormat dtitvfmtEn = DateIntervalFormat.getInstance(skeleton,ULocale.ENGLISH,dtitvinf);
      *         DateIntervalFormat dtitvfmtJa = DateIntervalFormat.getInstance(skeleton,ULocale.JAPANESE,dtitvinf);
diff --git a/icu4j/main/core/src/main/java/com/ibm/icu/text/SpoofChecker.java b/icu4j/main/core/src/main/java/com/ibm/icu/text/SpoofChecker.java
index 0d0426aad70..2d44d05882f 100644
--- a/icu4j/main/core/src/main/java/com/ibm/icu/text/SpoofChecker.java
+++ b/icu4j/main/core/src/main/java/com/ibm/icu/text/SpoofChecker.java
@@ -145,7 +145,7 @@ import com.ibm.icu.util.ULocale;
  * SpoofChecker sc = new SpoofChecker.Builder()
  *     .setAllowedChars(SpoofChecker.RECOMMENDED.cloneAsThawed().addAll(SpoofChecker.INCLUSION))
  *     .setRestrictionLevel(SpoofChecker.RestrictionLevel.MODERATELY_RESTRICTIVE)
- *     .setChecks(SpoofChecker.ALL_CHECKS &~ SpoofChecker.CONFUSABLE)
+ *     .setChecks(SpoofChecker.ALL_CHECKS &~ SpoofChecker.CONFUSABLE)
  *     .build();
  * boolean result = sc.failsChecks("pаypаl");  // with Cyrillic 'а' characters
  * System.out.println(result);  // true
@@ -166,7 +166,7 @@ import com.ibm.icu.util.ULocale;
  * SpoofChecker sc = new SpoofChecker.Builder()
  *     .setAllowedChars(SpoofChecker.RECOMMENDED.cloneAsThawed().addAll(SpoofChecker.INCLUSION))
  *     .setRestrictionLevel(SpoofChecker.RestrictionLevel.MODERATELY_RESTRICTIVE)
- *     .setChecks(SpoofChecker.ALL_CHECKS &~ SpoofChecker.CONFUSABLE)
+ *     .setChecks(SpoofChecker.ALL_CHECKS &~ SpoofChecker.CONFUSABLE)
  *     .build();
  * SpoofChecker.CheckResult checkResult = new SpoofChecker.CheckResult();
  * boolean result = sc.failsChecks("pаypаl", checkResult);
diff --git a/icu4j/main/core/src/main/java/com/ibm/icu/util/BasicTimeZone.java b/icu4j/main/core/src/main/java/com/ibm/icu/util/BasicTimeZone.java
index 712c9391bda..9d958a462ea 100644
--- a/icu4j/main/core/src/main/java/com/ibm/icu/util/BasicTimeZone.java
+++ b/icu4j/main/core/src/main/java/com/ibm/icu/util/BasicTimeZone.java
@@ -50,12 +50,12 @@ public abstract class BasicTimeZone extends TimeZone {
      * wallTimeFmt.setTimeZone(btz);
      *
      * long start = 1104537600000L;    // 2005-01-01 0:00 UTC
-     * for (int i = 0; i < 5; i++) {   // Up to 5 transitions
+     * for (int i = 0; i < 5; i++) {   // Up to 5 transitions
      *     TimeZoneTransition trans = btz.getNextTransition(start, false /* not including start time */);
      *
      *     // Display the transition time and offset information
      *     long transTime = trans.getTime();
-     *     System.out.println(wallTimeFmt.format(new Date(transTime - 1)) + " -> " + wallTimeFmt.format(new Date(transTime)));
+     *     System.out.println(wallTimeFmt.format(new Date(transTime - 1)) + " -> " + wallTimeFmt.format(new Date(transTime)));
      *     System.out.println(" - Before (Offset/Save): " + trans.getFrom().getRawOffset() + "/" + trans.getFrom().getDSTSavings());
      *     System.out.println(" - After  (Offset/Save): " + trans.getTo().getRawOffset() + "/" + trans.getTo().getDSTSavings());
      *
@@ -92,12 +92,12 @@ public abstract class BasicTimeZone extends TimeZone {
      * wallTimeFmt.setTimeZone(btz);
      *
      * long start = 1262304000000L;    // 2010-01-01 0:00 UTC
-     * for (int i = 0; i < 5; i++) {   // Up to 5 transitions
+     * for (int i = 0; i < 5; i++) {   // Up to 5 transitions
      *     TimeZoneTransition trans = btz.getPreviousTransition(start, false /* not including start time */);
      *
      *     // Display the transition time and offset information
      *     long transTime = trans.getTime();
-     *     System.out.println(wallTimeFmt.format(new Date(transTime - 1)) + " -> " + wallTimeFmt.format(new Date(transTime)));
+     *     System.out.println(wallTimeFmt.format(new Date(transTime - 1)) + " -> " + wallTimeFmt.format(new Date(transTime)));
      *     System.out.println(" - Before (Offset/Save): " + trans.getFrom().getRawOffset() + "/" + trans.getFrom().getDSTSavings());
      *     System.out.println(" - After  (Offset/Save): " + trans.getTo().getRawOffset() + "/" + trans.getTo().getDSTSavings());
      *
@@ -136,7 +136,7 @@ public abstract class BasicTimeZone extends TimeZone {
      * GregorianCalendar cal = new GregorianCalendar(TimeZone.getTimeZone("Etc/GMT"));
      *
      * // Compare these time zones every 10 years since year 1970 up to year 2009
-     * for (int startYear = 1970; startYear <= 2000; startYear += 10) {
+     * for (int startYear = 1970; startYear <= 2000; startYear += 10) {
      *     long start, end;
      *
      *     cal.set(startYear, Calendar.JANUARY, 1, 0, 0, 0);
@@ -323,7 +323,7 @@ public abstract class BasicTimeZone extends TimeZone {
      * long since = 1104537600000L;    // 2005-01-01 0:00 UTC
      * TimeZoneRule[] rules = btz.getTimeZoneRules(since);
      * System.out.println("Rule(initial): " + rules[0]);
-     * for (int i = 1; i < rules.length; i++) {
+     * for (int i = 1; i < rules.length; i++) {
      *     System.out.println("Rule: " + rules[i]);
      * }
      * 

diff --git a/icu4j/main/core/src/main/java/com/ibm/icu/util/MeasureUnit.java b/icu4j/main/core/src/main/java/com/ibm/icu/util/MeasureUnit.java
index 4ad82786f29..1f1acfb2d36 100644
--- a/icu4j/main/core/src/main/java/com/ibm/icu/util/MeasureUnit.java
+++ b/icu4j/main/core/src/main/java/com/ibm/icu/util/MeasureUnit.java
@@ -545,7 +545,7 @@ public class MeasureUnit implements Serializable {
     /**
      * Creates a new MeasureUnit with a specified constant denominator.
      * 

-     * This method is applicable only to COMPOUND & SINGLE units. If invoked on a
+     * This method is applicable only to COMPOUND & SINGLE units. If invoked on a
      * MIXED unit, an exception will be thrown.
      * For further details, refer to {@link Complexity}.
      * 

@@ -590,7 +590,7 @@ public class MeasureUnit implements Serializable {
      * zero.
      * 
      * 

-     * This method is applicable only to COMPOUND & SINGLE units. If invoked on a
+     * This method is applicable only to COMPOUND & SINGLE units. If invoked on a
      * MIXED unit, an exception will be thrown.
      * For further details, refer to {@link Complexity}.
      *