ICU-22921 Fix some javadoc issues

This commit is contained in:
Mihai Nita 2025-02-16 15:05:04 -08:00
parent 61b2dbc980
commit 3b2bd4b19d
8 changed files with 20 additions and 19 deletions

View file

@ -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.

View file

@ -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.

View file

@ -51,7 +51,7 @@ import java.util.Map;
* @Test
* public void test() {
* final Locale enGb = Locale.forLanguageTag("en-GB");
* Map<String, Object> arguments = new HashMap<>();
* Map&lt;String, Object&gt; arguments = new HashMap&lt;&gt;();
* 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<String, Object> arguments = new HashMap<>();
* Map&lt;String, Object&gt; arguments = new HashMap&lt;&gt;();
*
* MessageFormatter mf2 = MessageFormatter.builder()
* .setPattern(message)
@ -311,7 +311,7 @@ public class MessageFormatter {
* depending on this setting.</p>
*
* <p>Used in conjunction with the
* {@link MessageFormatter.Builder#setErrorHandlingBehavior(ErrorHandlingBehavior)} method.</p>
* {@link MessageFormatter.Builder#setErrorHandlingBehavior(MessageFormatter.ErrorHandlingBehavior)} method.</p>
*
* @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.</p>
*
* <p>Used in conjunction with the
* {@link MessageFormatter.Builder#setBidiIsolation(BidiIsolation)} method.</p>
* {@link MessageFormatter.Builder#setBidiIsolation(MessageFormatter.BidiIsolation)} method.</p>
*
* @internal ICU 77 technology preview
* @deprecated This API is for technology preview only.

View file

@ -20,7 +20,7 @@ import com.ibm.icu.util.ULocale;
* .locale(ULocale.UK)
* .formatRange(750, 1.2)
* .toString();
* // => "750 m - 1.2 km"
* // =&gt; "750 m - 1.2 km"
* </pre>
* <p>
* Like NumberFormatter, NumberRangeFormatter instances (i.e., LocalizedNumberRangeFormatter

View file

@ -571,7 +571,7 @@ public class DateIntervalFormat extends UFormat {
* getInstance(String skeleton, ULocale locale)
*
* <!-- From: com.ibm.icu.samples.text.dateintervalformat.DateIntervalFormatSample:dtitvfmtPreDefinedExample -->
* <p>Example code:<p>
* <p>Example code:</p>
*
* <pre>
* import java.util.Date;
@ -698,7 +698,7 @@ public class DateIntervalFormat extends UFormat {
* getInstance(String skeleton, ULocale locale, DateIntervalInfo dtitvinf)
*
* <!-- From: com.ibm.icu.samples.text.dateintervalformat.DateIntervalFormatSample:dtitvfmtCustomizedExample -->
* <p>Example code:<p>
* <p>Example code:</p>
*
* <pre>
* 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&lt;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);

View file

@ -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 &amp;~ 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 &amp;~ SpoofChecker.CONFUSABLE)
* .build();
* SpoofChecker.CheckResult checkResult = new SpoofChecker.CheckResult();
* boolean result = sc.failsChecks("pаypаl", checkResult);

View file

@ -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 &lt; 5; i++) { // Up to 5 transitions
* TimeZoneTransition trans = btz.getNextTransition(start, false /* not including start time *<code>/</code>);
*
* // 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)) + " -&gt; " + 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 &lt; 5; i++) { // Up to 5 transitions
* TimeZoneTransition trans = btz.getPreviousTransition(start, false /* not including start time *<code>/</code>);
*
* // 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)) + " -&gt; " + 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 &lt;= 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 &lt; rules.length; i++) {
* System.out.println("Rule: " + rules[i]);
* }
* </pre>

View file

@ -545,7 +545,7 @@ public class MeasureUnit implements Serializable {
/**
* Creates a new MeasureUnit with a specified constant denominator.
* <p>
* This method is applicable only to COMPOUND & SINGLE units. If invoked on a
* This method is applicable only to COMPOUND &amp; SINGLE units. If invoked on a
* MIXED unit, an exception will be thrown.
* For further details, refer to {@link Complexity}.
* <p>
@ -590,7 +590,7 @@ public class MeasureUnit implements Serializable {
* zero.</li>
* </ul>
* <p>
* This method is applicable only to COMPOUND & SINGLE units. If invoked on a
* This method is applicable only to COMPOUND &amp; SINGLE units. If invoked on a
* MIXED unit, an exception will be thrown.
* For further details, refer to {@link Complexity}.
* <p>