organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-07 22:44:49 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 2

ICU-22280 Replace markdown in javadoc with proper tags

Browse source
This commit is contained in:
Mihai Nita 2023-03-13 23:58:40 -07:00
parent b399c67d5a
commit 97510de5d4
36 changed files with 123 additions and 123 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
icu4j/main/classes/collate/src/com/ibm/icu/text/Collator.java
View file

@ -1493,7 +1493,7 @@ public abstract class Collator implements Comparator<Object>, Freezable<Collator
* <i>valid</i> locale).
*
* <p>Note: This method will be implemented in ICU 3.0; ICU 2.8
* contains a partial preview implementation. The * <i>actual</i>
* contains a partial preview implementation. The <i>actual</i>
* locale is returned correctly, but the <i>valid</i> locale is
* not, in most cases.
*

2
icu4j/main/classes/core/src/com/ibm/icu/impl/DayPeriodRules.java
View file

@ -239,7 +239,7 @@ public final class DayPeriodRules {
* Get a DayPeriodRules object given a locale.
* If data hasn't been loaded, it will be loaded for all locales at once.
* @param locale locale for which the DayPeriodRules object is requested.
* @return a DayPeriodRules object for `locale`.
* @return a DayPeriodRules object for {@code locale}.
*/
public static DayPeriodRules getInstance(ULocale locale) {
String localeCode = locale.getBaseName();

18
icu4j/main/classes/core/src/com/ibm/icu/impl/ICUResourceBundle.java
View file

@ -397,11 +397,11 @@ public class ICUResourceBundle extends UResourceBundle {
}
/**
* Locates the resource specified by `path` in this resource bundle (performing any necessary fallback and
* following any aliases) and calls the specified `sink`'s `put()` method with that resource. Then walks the
* bundle's parent chain, calling `put()` on the sink for each item in the parent chain.
* Locates the resource specified by {@code path} in this resource bundle (performing any necessary fallback
* and following any aliases) and calls the specified {@code sink}'s {@code put()} method with that resource.
* Then walks the bundle's parent chain, calling {@code put()} on the sink for each item in the parent chain.
* @param path The path of the desired resource
* @param sink A `UResource.Sink` that gets called for each resource in the parent chain
* @param sink A {@code UResource.Sink} that gets called for each resource in the parent chain
*/
public void getAllItemsWithFallback(String path, UResource.Sink sink)
throws MissingResourceException {
@ -430,16 +430,16 @@ public class ICUResourceBundle extends UResourceBundle {
}
/**
* Locates the resource specified by `path` in this resource bundle (performing any necessary fallback and
* Locates the resource specified by {@code path} in this resource bundle (performing any necessary fallback and
* following any aliases) and, if the resource is a table resource, iterates over its immediate child resources (again,
* following any aliases to get the individual resource values), and calls the specified `sink`'s `put()` method
* for each child resource (passing it that resource's key and either its actual value or, if that value is an
* following any aliases to get the individual resource values), and calls the specified {@code sink}'s {@code put()}
* method for each child resource (passing it that resource's key and either its actual value or, if that value is an
* alias, the value you get by following the alias). Then walks back over the bundle's parent chain,
* similarly iterating over each parent table resource's child resources.
* Does not descend beyond one level of table children.
* @param path The path of the desired resource
* @param sink A `UResource.Sink` that gets called for each child resource of the specified resource (and each child
* of the resources in its parent chain).
* @param sink A {@code UResource.Sink} that gets called for each child resource of the specified resource (and each
* child of the resources in its parent chain).
*/
public void getAllChildrenWithFallback(final String path, final UResource.Sink sink)
throws MissingResourceException {

2
icu4j/main/classes/core/src/com/ibm/icu/impl/OlsonTimeZone.java
View file

@ -475,7 +475,7 @@ public class OlsonTimeZone extends BasicTimeZone {
/**
* Construct from a resource bundle
* @param top the top-level zoneinfo resource bundle. This is used
* to lookup the rule that `res' may refer to, if there is one.
* to lookup the rule that {@code res} may refer to, if there is one.
* @param res the resource bundle of the zone to be constructed
* @param id time zone ID
*/

6
icu4j/main/classes/core/src/com/ibm/icu/impl/RuleCharacterIterator.java
View file

@ -217,11 +217,11 @@ public class RuleCharacterIterator {
* }
* iterator.setPos(pos);
*
* @param p a position object previously returned by getPos(),
* @param p a position object previously returned by {@code getPos()},
* or null. If not null, it will be updated and returned. If
* null, a new position object will be allocated and returned.
* @return a position object which may be passed to setPos(),
* either `p,' or if `p' == null, a newly-allocated object
* @return a position object which may be passed to setPos(), either
* {@code p}, or if {@code p} == null, a newly-allocated object
*/
public Position getPos(Position p) {
if (p == null) {

8
icu4j/main/classes/core/src/com/ibm/icu/impl/number/LongNameHandler.java
View file

@ -1299,8 +1299,8 @@ public class LongNameHandler
}
/**
* Sets modifiers to a combination of `leadFormats` (one per plural form)
* and `trailFormat` appended to each.
* Sets modifiers to a combination of {@code leadFormats} (one per plural form)
* and {@code trailFormat} appended to each.
*
* With a leadFormat of "{0}m" and a trailFormat of "{0}/s", it produces a
* pattern of "{0}m/s" by inserting each leadFormat pattern into
@ -1340,9 +1340,9 @@ public class LongNameHandler
}
/**
* Produces a plural-appropriate Modifier for a unit: `quantity` is taken as
* Produces a plural-appropriate Modifier for a unit: {@code quantity} is taken as
* the final smallest unit, while the larger unit values must be provided
* via `micros.mixedMeasures`.
* via {@code micros.mixedMeasures}.
*
* Does not call parent.processQuantity, so cannot get a MicroProps instance
* that way. Instead, the instance is passed in as a parameter.

4
icu4j/main/classes/core/src/com/ibm/icu/impl/number/MicroProps.java
View file

@ -80,8 +80,8 @@ public class MicroProps implements Cloneable, MicroPropsGenerator {
/**
* As MicroProps is the "base instance", this implementation of
* MircoPropsGenerator.processQuantity() just ensures that the output
* `micros` is correctly initialized.
* {@code MircoPropsGenerator.processQuantity()} just ensures that the output
* {@code micros} is correctly initialized.
* <p>
* For the "safe" invocation of this function, micros must not be *this,
* such that a copy of the base instance is made. For the "unsafe" path,

8
icu4j/main/classes/core/src/com/ibm/icu/impl/number/MixedUnitLongNameHandler.java
View file

@ -103,9 +103,9 @@ public class MixedUnitLongNameHandler
}
/**
* Produces a plural-appropriate Modifier for a mixed unit: `quantity` is
* Produces a plural-appropriate Modifier for a mixed unit: {@code quantity} is
* taken as the final smallest unit, while the larger unit values must be
* provided by `micros.mixedMeasures`, micros being the MicroProps instance
* provided by {@code micros.mixedMeasures}, micros being the MicroProps instance
* returned by the parent.
*
* This function must not be called if this instance has no parent: call
@ -121,9 +121,9 @@ public class MixedUnitLongNameHandler
}
/**
* Produces a plural-appropriate Modifier for a mixed unit: `quantity` is
* Produces a plural-appropriate Modifier for a mixed unit: {@code quantity} is
* taken as the final smallest unit, while the larger unit values must be
* provided via `micros.mixedMeasures`.
* provided via {@code micros.mixedMeasures}.
*
* Does not call parent.processQuantity, so cannot get a MicroProps instance
* that way. Instead, the instance is passed in as a parameter.

12
icu4j/main/classes/core/src/com/ibm/icu/impl/units/ComplexUnitsConverter.java
View file

@ -15,7 +15,8 @@ import com.ibm.icu.number.Precision;
import com.ibm.icu.util.Measure;
/**
* Converts from single or compound unit to single, compound or mixed units. For example, from `meter` to `foot+inch`.
* Converts from single or compound unit to single, compound or mixed units. For example, from {@code meter}
* to {@code foot+inch}.
* <p>
* DESIGN: This class uses <code>UnitsConverter</code> in order to perform the single converter (i.e. converters from
* a single unit to another single unit). Therefore, <code>ComplexUnitsConverter</code> class contains multiple
@ -135,11 +136,12 @@ public class ComplexUnitsConverter {
}
/**
* Returns true if the specified `quantity` of the `inputUnit`, expressed in terms of the biggest unit in the
* MeasureUnit `outputUnit`, is greater than or equal to `limit`.
* Returns true if the specified {@code quantity} of the {@code inputUnit}, expressed in terms of the biggest
* unit in the MeasureUnit {@code outputUnit}, is greater than or equal to {@code limit}.
* <p>
* For example, if the input unit is `meter` and the target unit is `foot+inch`. Therefore, this function will
* convert the `quantity` from `meter` to `foot`, then, it will compare the value in `foot` with the `limit`.
* For example, if the input unit is {@code meter} and the target unit is {@code foot+inch}. Therefore,
* this function will convert the {@code quantity} from {@code meter} to {@code foot}, then, it will
* compare the value in {@code foot} with the {@code limit}.
*/
public boolean greaterThanOrEqual(BigDecimal quantity, BigDecimal limit) {
assert !units_.isEmpty();

8
icu4j/main/classes/core/src/com/ibm/icu/impl/units/ConversionRates.java
View file

@ -32,7 +32,7 @@ public class ConversionRates {
}
/**
* Extracts the factor from a `SingleUnitImpl` to its Basic Unit.
* Extracts the factor from a {@code SingleUnitImpl} to its Basic Unit.
*
* @param singleUnit
* @return
@ -102,7 +102,7 @@ public class ConversionRates {
/**
* @param singleUnit An instance of SingleUnitImpl.
* @return The base units in the `SingleUnitImpl` with applying the dimensionality only and not the SI prefix.
* @return The base units in the {@code SingleUnitImpl} with applying the dimensionality only and not the SI prefix.
* <p>
* NOTE:
* This method is helpful when checking the convertibility because no need to check convertibility.
@ -120,10 +120,10 @@ public class ConversionRates {
}
/**
* Checks if the `MeasureUnitImpl` is simple or not.
* Checks if the {@code MeasureUnitImpl} is simple or not.
*
* @param measureUnitImpl
* @return true if the `MeasureUnitImpl` is simple, false otherwise.
* @return true if the {@code MeasureUnitImpl} is simple, false otherwise.
*/
private boolean checkSimpleUnit(MeasureUnitImpl measureUnitImpl) {
if (measureUnitImpl.getComplexity() != MeasureUnit.Complexity.SINGLE) return false;

2
icu4j/main/classes/core/src/com/ibm/icu/impl/units/SingleUnitImpl.java
View file

@ -28,7 +28,7 @@ public class SingleUnitImpl {
*/
private String simpleUnitID = "";
/**
* Determine the power of the `SingleUnit`. For example, for "square-meter", the dimensionality will be `2`.
* Determine the power of the {@code SingleUnit}. For example, for "square-meter", the dimensionality will be {@code 2}.
* <p>
* NOTE:
* Default dimensionality is 1.

4
icu4j/main/classes/core/src/com/ibm/icu/impl/units/UnitsConverter.java
View file

@ -254,7 +254,7 @@ public class UnitsConverter {
}
/**
* Returns a single `BigDecimal` that represent the conversion rate after substituting all the constants.
* Returns a single {@code BigDecimal} that represent the conversion rate after substituting all the constants.
*
* In ICU4C, see Factor::substituteConstants().
*/
@ -388,7 +388,7 @@ public class UnitsConverter {
}
/**
* Adds Entity with power or not. For example, `12 ^ 3` or `12`.
* Adds Entity with power or not. For example, {@code 12 ^ 3} or {@code 12}.
*
* @param poweredEntity
*/

6
icu4j/main/classes/core/src/com/ibm/icu/impl/units/UnitsData.java
View file

@ -221,10 +221,10 @@ public class UnitsData {
}
/**
* A Resource Sink that collects information from `unitQuantities` in the
* `units` resource to provide key->value lookups from base unit to
* A Resource Sink that collects information from {@code unitQuantities} in the
* {@code units} resource to provide key->value lookups from base unit to
* category, as well as preserving ordering information for these
* categories. See `units.txt`.
* categories. See {@code units.txt}.
*
* For example: "kilogram" -> "mass", "meter-per-second" -> "speed".
*

34
icu4j/main/classes/core/src/com/ibm/icu/impl/units/UnitsRouter.java
View file

@ -13,32 +13,32 @@ import com.ibm.icu.util.MeasureUnit;
import com.ibm.icu.util.ULocale;
/**
* `UnitsRouter` responsible for converting from a single unit (such as `meter` or `meter-per-second`) to
* one of the complex units based on the limits.
* {@code UnitsRouter} responsible for converting from a single unit (such as {@code meter} or
* {@code meter-per-second}) to one of the complex units based on the limits.
* For example:
* if the input is `meter` and the output as following
* {`foot+inch`, limit: 3.0}
* {`inch` , limit: no value (-inf)}
* Thus means if the input in `meter` is greater than or equal to `3.0 feet`, the output will be in
* `foot+inch`, otherwise, the output will be in `inch`.
* if the input is {@code meter} and the output as following
* {{@code foot+inch}, limit: 3.0}
* {{@code inch} , limit: no value (-inf)}
* Thus means if the input in {@code meter} is greater than or equal to {@code 3.0 feet},
* the output will be in {@code foot+inch}, otherwise, the output will be in {@code inch}.
* <p>
* NOTE:
* the output units and their limits MUST BE in order, for example, if the output units, from the
* previous example, are the following:
* {`inch` , limit: no value (-inf)}
* {`foot+inch`, limit: 3.0}
* IN THIS CASE THE OUTPUT WILL BE ALWAYS IN `inch`.
* {{@code inch} , limit: no value (-inf)}
* {{@code foot+inch}, limit: 3.0}
* IN THIS CASE THE OUTPUT WILL BE ALWAYS IN {@code inch}.
* <p>
* NOTE:
* the output units and their limits will be extracted from the units preferences database by knowing
* the output units and their limits will be extracted from the units preferences database by knowing
* the followings:
* - input unit
* - locale
* - usage
* <p>
* DESIGN:
* `UnitRouter` uses internally `ComplexUnitConverter` in order to convert the input units to the
* desired complex units and to check the limit too.
* {@code UnitRouter} uses internally {@code ComplexUnitConverter} in order to convert the input
* units to the desired complex units and to check the limit too.
*/
public class UnitsRouter {
// List of possible output units. TODO: converterPreferences_ now also has
@ -146,12 +146,12 @@ public class UnitsRouter {
/**
* Contains the complex unit converter and the limit which representing the smallest value that the
* converter should accept. For example, if the converter is converting to `foot+inch` and the limit
* equals 3.0, thus means the converter should not convert to a value less than `3.0 feet`.
* converter should accept. For example, if the converter is converting to {@code foot+inch} and the
* limit equals 3.0, thus means the converter should not convert to a value less than {@code 3.0 feet}.
* <p>
* NOTE:
* if the limit doest not has a value `i.e. (std::numeric_limits<double>::lowest())`, this mean there
* is no limit for the converter.
* if the limit doest not has a value (i.e. {@code std::numeric_limits<double>::lowest()}),
* this mean there is no limit for the converter.
*/
public static class ConverterPreference {
// The output unit for this ConverterPreference. This may be a MIXED unit -

4
icu4j/main/classes/core/src/com/ibm/icu/lang/CharSequences.java
View file

@ -123,7 +123,7 @@ public class CharSequences {
* Same results as turning the code point into a string (with the [ugly] new StringBuilder().appendCodePoint(codepoint).toString())
* and comparing, but much faster (no object creation).
* Actually, there is one difference; a null compares as less.
* Note that this (=String) order is UTF-16 order -- *not* code point order.
* Note that this (=String) order is UTF-16 order -- <i>not</i> code point order.
*
* @internal
* @deprecated This API is ICU internal only.
@ -167,7 +167,7 @@ public class CharSequences {
* Utility to compare a string to a code point.
* Same results as turning the code point into a string and comparing, but much faster (no object creation).
* Actually, there is one difference; a null compares as less.
* Note that this (=String) order is UTF-16 order -- *not* code point order.
* Note that this (=String) order is UTF-16 order -- <i>not</i> code point order.
*
* @internal
* @deprecated This API is ICU internal only.

15
icu4j/main/classes/core/src/com/ibm/icu/lang/UCharacter.java
View file

@ -4944,9 +4944,10 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
/**
* {@icu} Returns the most current Unicode name of the argument code point, or
* null if the character is unassigned or outside the range
* UCharacter.MIN_VALUE and UCharacter.MAX_VALUE or does not have a name.
* {@code UCharacter.MIN_VALUE} and {@code UCharacter.MAX_VALUE} or does not
* have a name.
* <br>
* Note calling any methods related to code point names, e.g. get*Name*()
* Note calling any methods related to code point names, e.g. {@code getName()}
* incurs a one-time initialization cost to construct the name tables.
* @param ch the code point for which to get the name
* @return most current Unicode name
@ -5003,7 +5004,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
* <li> Extended name in the form of
* "&lt;codepoint_type-codepoint_hex_digits&gt;". E.g., &lt;noncharacter-fffe&gt;
* </ul>
* Note calling any methods related to code point names, e.g. get*Name*()
* Note calling any methods related to code point names, e.g. {@code getName()}
* incurs a one-time initialization cost to construct the name tables.
* @param ch the code point for which to get the name
* @return a name for the argument codepoint
@ -5018,7 +5019,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
* Returns null if the character is unassigned or outside the range
* UCharacter.MIN_VALUE and UCharacter.MAX_VALUE or does not have a name.
* <br>
* Note calling any methods related to code point names, e.g. get*Name*()
* Note calling any methods related to code point names, e.g. {@code getName()}
* incurs a one-time initialization cost to construct the name tables.
* @param ch the code point for which to get the name alias
* @return Unicode name alias, or null
@ -5048,7 +5049,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
/**
* {@icu} <p>Finds a Unicode code point by its most current Unicode name and
* return its code point value. All Unicode names are in uppercase.
* Note calling any methods related to code point names, e.g. get*Name*()
* Note calling any methods related to code point names, e.g. {@code getName()}
* incurs a one-time initialization cost to construct the name tables.
* @param name most current Unicode character name whose code point is to
* be returned
@ -5087,7 +5088,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
* <li> Extended name in the form of
* "&lt;codepoint_type-codepoint_hex_digits&gt;". E.g. &lt;noncharacter-FFFE&gt;
* </ul>
* Note calling any methods related to code point names, e.g. get*Name*()
* Note calling any methods related to code point names, e.g. {@code getName()}
* incurs a one-time initialization cost to construct the name tables.
* @param name codepoint name
* @return code point associated with the name or -1 if the name is not
@ -5102,7 +5103,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
/**
* {@icu} <p>Find a Unicode character by its corrected name alias and return
* its code point value. All Unicode names are in uppercase.
* Note calling any methods related to code point names, e.g. get*Name*()
* Note calling any methods related to code point names, e.g. {@code getName()}
* incurs a one-time initialization cost to construct the name tables.
* @param name Unicode name alias whose code point is to be returned
* @return code point or -1 if name is not found

2
icu4j/main/classes/core/src/com/ibm/icu/lang/UProperty.java
View file

@ -316,7 +316,7 @@ public interface UProperty
/**
* <p>Binary property Case_Sensitive.
* <p>Either the source of a case
* mapping or _in_ the target of a case mapping. Not the same as
* mapping or <i>in</i> the target of a case mapping. Not the same as
* the general category Cased_Letter.
* @stable ICU 2.6
*/

21
icu4j/main/classes/core/src/com/ibm/icu/message2/MessageFormatter.java
View file

@ -45,21 +45,21 @@ import java.util.Map;
* import java.util.HashMap;
* import java.util.Locale;
* import java.util.Map;
*
*
* import com.ibm.icu.message2.MessageFormatter;
*
* @Test
*
* &#064;Test
* public void testMf2() {
* final Locale enGb = Locale.forLanguageTag("en-GB");
* Map<String, Object> arguments = new HashMap<>();
* arguments.put("name", "John");
* arguments.put("exp", new Date(1679971371000L)); // March 27, 2023, 7:42:51 PM
*
*
* MessageFormatter mf2 = MessageFormatter.builder()
* .setPattern("{Hello {$name}, your card expires on {$exp :datetime skeleton=yMMMdE}!}")
* .setLocale(enGb)
* .build();
*
*
* assertEquals(
* "Hello John, your card expires on Mon, 27 Mar 2023!",
* mf2.formatToString(arguments));
@ -94,27 +94,24 @@ import java.util.Map;
* <h4>Plural selection message</h4>
*
* <blockquote><pre>
* @Test
* &#064;Test
* public void testMf2Selection() {
* final String message = "match {$count :plural}\n"
* + " when one {You have one notification.}\n"
* + " when * {You have {$count} notifications.}\n";
* final Locale enGb = Locale.forLanguageTag("en-GB");
* Map<String, Object> arguments = new HashMap<>();
*
*
*
* MessageFormatter mf2 = MessageFormatter.builder()
* .setPattern(message)
* .setLocale(enGb)
* .build();
*
*
*
* arguments.put("count", 1);
* assertEquals(
* "You have one notification.",
* mf2.formatToString(arguments));
*
*
*
* arguments.put("count", 42);
* assertEquals(
* "You have 42 notifications.",

4
icu4j/main/classes/core/src/com/ibm/icu/number/FormattedNumber.java
View file

@ -130,7 +130,7 @@ public class FormattedNumber implements FormattedValue {
* MeasureUnit.Complexity.MIXED unit complexity (MeasureUnit.getComplexity()), such
* as "foot-and-inch" or "hour-and-minute-and-second".
*
* @return `MeasureUnit`.
* @return {@code MeasureUnit}.
* @stable ICU 68
*/
public MeasureUnit getOutputUnit() {
@ -138,7 +138,7 @@ public class FormattedNumber implements FormattedValue {
}
/**
* Gets the noun class of the formatted output. Returns `UNDEFINED` when the noun class is not
* Gets the noun class of the formatted output. Returns {@code UNDEFINED} when the noun class is not
* supported yet.
*
* @return NounClass

4
icu4j/main/classes/core/src/com/ibm/icu/number/FractionPrecision.java
View file

@ -62,7 +62,7 @@ public abstract class FractionPrecision extends Precision {
* not "3.0".
*
* <p>
* This is equivalent to `withSignificantDigits(1, minSignificantDigits, RELAXED)`.
* This is equivalent to {@code withSignificantDigits(1, minSignificantDigits, RELAXED)}.
*
* @param minSignificantDigits
* The number of significant figures to guarantee.
@ -95,7 +95,7 @@ public abstract class FractionPrecision extends Precision {
* 123.4 would become "120.00".
*
* <p>
* This is equivalent to `withSignificantDigits(1, maxSignificantDigits, STRICT)`.
* This is equivalent to {@code withSignificantDigits(1, maxSignificantDigits, STRICT)}.
*
* @param maxSignificantDigits
* Round the number to no more than this number of significant figures.

2
icu4j/main/classes/core/src/com/ibm/icu/number/NumberFormatter.java
View file

@ -85,7 +85,7 @@ public final class NumberFormatter {
* integer), Max-Significant = 2 (round to 2 significant digits), and priority RELAXED (choose
* the constraint that results in more digits being displayed).
*
* <p>Conflicting *minimum* fraction and significant digits are always resolved in the direction that
* <p>Conflicting <i>minimum</i> fraction and significant digits are always resolved in the direction that
* results in more trailing zeros.
*
* <p>Example 1: Consider the number 3.141, with various different settings:

6
icu4j/main/classes/core/src/com/ibm/icu/number/NumberFormatterSettings.java
View file

@ -139,7 +139,7 @@ public abstract class NumberFormatterSettings<T extends NumberFormatterSettings<
*
* <p>
* If the input usage is correctly set the output unit <b>will change</b>
* according to `usage`, `locale` and `unit` value.
* according to {@code usage}, {@code locale} and {@code unit} value.
* </p>
*
* @param unit
@ -500,8 +500,8 @@ public abstract class NumberFormatterSettings<T extends NumberFormatterSettings<
* "road", "rainfall", etc.)
*
* <p>
* When a `usage` is specified, the output unit will change depending on the
* `Locale` and the unit quantity. For example, formatting length
* When a {@code usage} is specified, the output unit will change depending on the
* {@code Locale} and the unit quantity. For example, formatting length
* measurements specified in meters:
*
* <pre>

2
icu4j/main/classes/core/src/com/ibm/icu/text/BreakIterator.java
View file

@ -66,7 +66,7 @@ import com.ibm.icu.util.ULocale;
* <ul><li>The beginning and end of the text are always treated as boundary positions.
* <li>The current position of the iterator is always a boundary position (random-
* access methods move the iterator to the nearest boundary position before or
* after the specified position, not _to_ the specified position).
* after the specified position, not <i>to</i> the specified position).
* <li>DONE is used as a flag to indicate when iteration has stopped. DONE is only
* returned when the current position is the end of the text and the user calls next(),
* or when the current position is the beginning of the text and the user calls

2
icu4j/main/classes/core/src/com/ibm/icu/text/DateFormatSymbols.java
View file

@ -2351,7 +2351,7 @@ public class DateFormatSymbols implements Serializable, Cloneable {
* <i>valid</i> locale).
*
* <p>Note: This method will be implemented in ICU 3.0; ICU 2.8
* contains a partial preview implementation. The * <i>actual</i>
* contains a partial preview implementation. The <i>actual</i>
* locale is returned correctly, but the <i>valid</i> locale is
* not, in most cases.
* @param type type of information requested, either {@link

4
icu4j/main/classes/core/src/com/ibm/icu/text/DateIntervalFormat.java
View file

@ -1179,7 +1179,7 @@ public class DateIntervalFormat extends UFormat {
* @param source The string to be parsed into an object.
* @param parse_pos The position to start parsing at. Since no parsing
* is supported, upon return this param is unchanged.
* @return A newly created Formattable* object, or NULL
* @return A newly created {@code Formattable} object, or NULL
* on failure.
* @internal
* @deprecated This API is ICU internal only.
@ -2232,7 +2232,7 @@ public class DateIntervalFormat extends UFormat {
* substitution inside quoted literal text.
* @param targetString The string to perform the find-replace operation on.
* @param strToReplace The string to search for and replace in the target string.
* @param strToReplaceWith The string to substitute in wherever `stringToReplace` was found.
* @param strToReplaceWith The string to substitute in wherever {@code stringToReplace} was found.
*/
private static String findReplaceInPattern(String targetString,
String strToReplace,

2
icu4j/main/classes/core/src/com/ibm/icu/text/PersonName.java
View file

@ -247,7 +247,7 @@ public interface PersonName {
* Returns one field of the name, possibly in a modified form.
*
* @param identifier The identifier of the requested field.
* @param modifiers An **IN/OUT** parameter that specifies modifiers to apply to the basic field value.
* @param modifiers An <b>IN/OUT</b> parameter that specifies modifiers to apply to the basic field value.
* An implementing class can choose to handle or ignore any modifiers; it should modify
* the passed-in Set so that on exit, it contains only the requested modifiers that it
* DIDN'T handle. This parameter may not be null, and must either be mutable or empty.

6
icu4j/main/classes/core/src/com/ibm/icu/text/PluralRules.java
View file

@ -87,7 +87,7 @@ import com.ibm.icu.util.ULocale;
* This illustrates conjunction and negation. The condition for 'few' has two parts, both of which must be met:
* "n mod 10 in 2..4" and "n mod 100 not in 12..14". The first part applies a modulus to n before the test as in the
* previous example. The second part applies a different modulus and also uses negation, thus it matches all numbers
* _not_ in 12, 13, 14, 112, 113, 114, 212, 213, 214...
* <i>not</i> in 12, 13, 14, 112, 113, 114, 212, 213, 214...
* </p>
* <p>
* Syntax:
@ -503,7 +503,7 @@ public class PluralRules implements Serializable {
e,
/**
* This operand is currently treated as an alias for `PLURAL_OPERAND_E`.
* This operand is currently treated as an alias for {@code PLURAL_OPERAND_E}.
* In the future, it will represent:
*
* Suppressed exponent for compact notation (exponent needed in
@ -692,7 +692,7 @@ public class PluralRules implements Serializable {
* @param f Corresponds to f in the plural rules grammar.
* The digits to the right of the decimal place as an integer. e.g 1.10 = 10
* @param e Suppressed exponent for scientific notation
* @param c Currently: an alias for param `e`
* @param c Currently: an alias for param {@code e}
*/
@Deprecated
public FixedDecimal(double n, int v, long f, int e, int c) {

2
icu4j/main/classes/core/src/com/ibm/icu/text/SimplePersonName.java
View file

@ -163,7 +163,7 @@ public class SimplePersonName implements PersonName {
* provided at construction time, and this function will return them. Otherwise, it ignores modifiers and
* relies on PersonNameFormat's default modifier handling.
* @param nameField The identifier of the requested field.
* @param modifiers An **IN/OUT** parameter that specifies modifiers to apply to the basic field value.
* @param modifiers An <b>IN/OUT</b> parameter that specifies modifiers to apply to the basic field value.
* On return, this list will contain any modifiers that this object didn't handle. This class
* will always return this set unmodified, unless a modified version of the requested field
* was provided at construction time.

4
icu4j/main/classes/core/src/com/ibm/icu/text/UnicodeSet.java
View file

@ -4776,7 +4776,7 @@ public class UnicodeSet extends UnicodeFilter implements Iterable<String>, Compa
* Same results as turning the code point into a string (with the [ugly] new StringBuilder().appendCodePoint(codepoint).toString())
* and comparing, but much faster (no object creation).
* Actually, there is one difference; a null compares as less.
* Note that this (=String) order is UTF-16 order -- *not* code point order.
* Note that this (=String) order is UTF-16 order -- <i>not</i> code point order.
* @stable ICU 4.4
*/
@ -4788,7 +4788,7 @@ public class UnicodeSet extends UnicodeFilter implements Iterable<String>, Compa
* Utility to compare a string to a code point.
* Same results as turning the code point into a string and comparing, but much faster (no object creation).
* Actually, there is one difference; a null compares as less.
* Note that this (=String) order is UTF-16 order -- *not* code point order.
* Note that this (=String) order is UTF-16 order -- <i>not</i> code point order.
* @stable ICU 4.4
*/
public static int compare(int codePoint, CharSequence string) {

2
icu4j/main/classes/core/src/com/ibm/icu/util/Calendar.java
View file

@ -6548,7 +6548,7 @@ public abstract class Calendar implements Serializable, Cloneable, Comparable<Ca
* <i>valid</i> locale).
*
* <p>Note: This method will be implemented in ICU 3.0; ICU 2.8
* contains a partial preview implementation. The * <i>actual</i>
* contains a partial preview implementation. The <i>actual</i>
* locale is returned correctly, but the <i>valid</i> locale is
* not, in most cases.
* @param type type of information requested, either {@link

8
icu4j/main/classes/core/src/com/ibm/icu/util/CodePointMap.java
View file

@ -39,10 +39,10 @@ public abstract class CodePointMap implements Iterable<CodePointMap.Range> {
*
* <p>Most users should use NORMAL instead.
*
* <p>This option is useful for maps that map surrogate code *units* to
* <p>This option is useful for maps that map surrogate code <i>units</i> to
* special values optimized for UTF-16 string processing
* or for special error behavior for unpaired surrogates,
* but those values are not to be associated with the lead surrogate code *points*.
* but those values are not to be associated with the lead surrogate code <i>points</i>.
*
* @stable ICU 63
*/
@ -56,10 +56,10 @@ public abstract class CodePointMap implements Iterable<CodePointMap.Range> {
*
* <p>Most users should use NORMAL instead.
*
* <p>This option is useful for maps that map surrogate code *units* to
* <p>This option is useful for maps that map surrogate code <i>units</i> to
* special values optimized for UTF-16 string processing
* or for special error behavior for unpaired surrogates,
* but those values are not to be associated with the lead surrogate code *points*.
* but those values are not to be associated with the lead surrogate code <i>points</i>.
*
* @stable ICU 63
*/

2
icu4j/main/classes/core/src/com/ibm/icu/util/LocalePriorityList.java
View file

@ -63,7 +63,7 @@ import java.util.regex.Pattern;
* ja;q=0.3</pre>
* If it is off (the default), then all weights are reset to 1.0 after reordering.
* This is to match the effect of the Accept-Language semantics as used in browsers, and results in the following:
* * <pre> en;q=1.0
* <pre> en;q=1.0
* de;q=1.0
* fr;q=1.0
* ja;q=1.0</pre>

14
icu4j/main/classes/core/src/com/ibm/icu/util/MeasureUnit.java
View file

@ -469,12 +469,12 @@ public class MeasureUnit implements Serializable {
/**
* Creates a MeasureUnit which is this SINGLE unit augmented with the specified prefix.
* For example, MeasurePrefix.KILO for "kilo", or MeasurePrefix.KIBI for "kibi".
* May return `this` if this unit already has that prefix.
* May return {@code this} if this unit already has that prefix.
* <p>
* There is sufficient locale data to format all standard prefixes.
* <p>
* NOTE: Only works on SINGLE units. If this is a COMPOUND or MIXED unit, an error will
* occur. For more information, see `Complexity`.
* occur. For more information, {@link Complexity}.
*
* @param prefix The prefix, from MeasurePrefix.
* @return A new SINGLE unit.
@ -492,7 +492,7 @@ public class MeasureUnit implements Serializable {
* if the unit has the prefix "kilo", then MeasurePrefix.KILO is returned.
* <p>
* NOTE: Only works on SINGLE units. If this is a COMPOUND or MIXED unit, an
* error will occur. For more information, see `Complexity`.
* error will occur. For more information, {@link Complexity}.
*
* @return The prefix of this SINGLE unit, from MeasurePrefix.
* @throws UnsupportedOperationException if the unit is COMPOUND or MIXED.
@ -507,7 +507,7 @@ public class MeasureUnit implements Serializable {
* then 2 is returned.
* <p>
* NOTE: Only works on SINGLE units. If this is a COMPOUND or MIXED unit, an exception will be thrown.
* For more information, see `Complexity`.
* For more information, {@link Complexity}.
*
* @return The dimensionality (power) of this simple unit.
* @throws UnsupportedOperationException if the unit is COMPOUND or MIXED.
@ -522,7 +522,7 @@ public class MeasureUnit implements Serializable {
* (power). For example, if dimensionality is 2, the unit will be squared.
* <p>
* NOTE: Only works on SINGLE units. If this is a COMPOUND or MIXED unit, an exception is thrown.
* For more information, see `Complexity`.
* For more information, {@link Complexity}.
*
* @param dimensionality The dimensionality (power).
* @return A new SINGLE unit.
@ -541,7 +541,7 @@ public class MeasureUnit implements Serializable {
* For example, if the receiver is "meter-per-second", the unit "second-per-meter" is returned.
* <p>
* NOTE: Only works on SINGLE and COMPOUND units. If this is a MIXED unit, an error will
* occur. For more information, see `Complexity`.
* occur. For more information, {@link Complexity}.
*
* @return The reciprocal of the target unit.
* @throws UnsupportedOperationException if the unit is MIXED.
@ -563,7 +563,7 @@ public class MeasureUnit implements Serializable {
* unit "kilowatt-hour-per-day" is returned.
* <p>
* NOTE: Only works on SINGLE and COMPOUND units. If either unit (receivee and argument) is a
* MIXED unit, an error will occur. For more information, see `Complexity`.
* MIXED unit, an error will occur. For more information, {@link Complexity}.
*
* @param other The MeasureUnit to multiply with the target.
* @return The product of the target unit with the provided unit.

16
icu4j/main/classes/core/src/com/ibm/icu/util/TimeZone.java
View file

@ -286,7 +286,7 @@ abstract public class TimeZone implements Serializable, Cloneable, Freezable<Tim
/**
* Gets the time zone offset, for current date, modified in case of
* daylight savings. This is the offset to add *to* UTC to get local time.
* daylight savings. This is the offset to add <i>to</i> UTC to get local time.
* @param era the era of the given date.
* @param year the year in the given date.
* @param month the month in the given date.
@ -294,7 +294,7 @@ abstract public class TimeZone implements Serializable, Cloneable, Freezable<Tim
* @param day the day-in-month of the given date.
* @param dayOfWeek the day-of-week of the given date.
* @param milliseconds the millis in day in <em>standard</em> local time.
* @return the offset to add *to* GMT to get local time.
* @return the offset to add <i>to</i> GMT to get local time.
* @stable ICU 2.0
*/
abstract public int getOffset(int era, int year, int month, int day,
@ -330,13 +330,13 @@ abstract public class TimeZone implements Serializable, Cloneable, Freezable<Tim
*
* @param date moment in time for which to return offsets, in
* units of milliseconds from January 1, 1970 0:00 GMT, either GMT
* time or local wall time, depending on `local'.
* @param local if true, `date' is local wall time; otherwise it
* time or local wall time, depending on {@code local}.
* @param local if true, {@code date} is local wall time; otherwise it
* is in GMT time.
* @param offsets output parameter to receive the raw offset, that
* is, the offset not including DST adjustments, in offsets[0],
* and the DST offset, that is, the offset to be added to
* `rawOffset' to obtain the total offset between local and GMT
* {@code rawOffset} to obtain the total offset between local and GMT
* time, in offsets[1]. If DST is not in effect, the DST offset is
* zero; otherwise it is a positive value, typically one hour.
*
@ -377,7 +377,7 @@ abstract public class TimeZone implements Serializable, Cloneable, Freezable<Tim
/**
* Sets the base time zone offset to GMT.
* This is the offset to add *to* UTC to get local time.
* This is the offset to add <i>to</i> UTC to get local time.
* @param offsetMillis the given base time zone offset to GMT.
* @stable ICU 2.0
*/
@ -385,8 +385,8 @@ abstract public class TimeZone implements Serializable, Cloneable, Freezable<Tim
/**
* Gets unmodified offset, NOT modified in case of daylight savings.
* This is the offset to add *to* UTC to get local time.
* @return the unmodified offset to add *to* UTC to get local time.
* This is the offset to add <i>to</i> UTC to get local time.
* @return the unmodified offset to add <i>to</i> UTC to get local time.
* @stable ICU 2.0
*/
abstract public int getRawOffset();

4
icu4j/main/tests/collate/src/com/ibm/icu/dev/test/util/ULocaleCollationTest.java
View file

@ -85,8 +85,8 @@ public class ULocaleCollationTest extends TestFmwk {
/**
* Compare two locale IDs. If they are equal, return 0. If `string'
* starts with `prefix' plus an additional element, that is, string ==
* Compare two locale IDs. If they are equal, return 0. If {@code string}
* starts with {@code prefix} plus an additional element, that is, string ==
* prefix + '_' + x, then return 1. Otherwise return a value < 0.
*/
static int loccmp(String string, String prefix) {

4
icu4j/main/tests/core/src/com/ibm/icu/dev/test/format/PluralRulesTest.java
View file

@ -1238,7 +1238,7 @@ public class PluralRulesTest extends TestFmwk {
// for the scientific exponent operand `e` and compact notation.
/**
* Test the proper plural rule keyword selection given an input number that is
* already formatted into scientific notation. This exercises the `e` plural operand
* already formatted into scientific notation. This exercises the {@code e} plural operand
* for the formatted number.
*/
@Test
@ -1292,7 +1292,7 @@ public class PluralRulesTest extends TestFmwk {
/**
* Test the proper plural rule keyword selection given an input number that is
* already formatted into compact notation. This exercises the `c` plural operand
* already formatted into compact notation. This exercises the {@code c} plural operand
* for the formatted number.
*/
@Test