From 08ae9f2909b2ec37f755dac4372553437e9d7cf6 Mon Sep 17 00:00:00 2001
From: Paul Duffin <paulduffin@google.com>
Date: Tue, 1 Mar 2016 13:13:48 +0000
Subject: Integrate changes cherry-picked for ticket #12005 into android_icu4j.

Fix numerous warnings / errors from Javadoc generation

Bug: 22023363
(cherry picked from bfab1e7fec36dff93fb980c546ad64a565faf9fc)
Change-Id: I7e97889b415a9e4c83c9b821b939a7ee8d2a96e4
---
 .../src/main/java/android/icu/lang/UCharacter.java | 162 ++++++++++-----------
 1 file changed, 81 insertions(+), 81 deletions(-)

(limited to 'android_icu4j/src/main/java/android/icu/lang/UCharacter.java')

diff --git a/android_icu4j/src/main/java/android/icu/lang/UCharacter.java b/android_icu4j/src/main/java/android/icu/lang/UCharacter.java
index ad24d9e05..d0f66b80b 100644
--- a/android_icu4j/src/main/java/android/icu/lang/UCharacter.java
+++ b/android_icu4j/src/main/java/android/icu/lang/UCharacter.java
@@ -2934,7 +2934,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
      * adjust it by looking for the next cased character, and titlecase that one.
      * Other characters are lowercased.
      *
-     * This follows Unicode 4 & 5 section 3.13 Default Case Operations:
+     * This follows Unicode 4 &amp; 5 section 3.13 Default Case Operations:
      *
      * R3  toTitlecase(X): Find the word boundaries based on Unicode Standard Annex
      * #29, "Text Boundaries." Between each pair of word boundaries, find the first
@@ -3021,16 +3021,16 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
 
     /**
      * <strong>[icu]</strong> Returns the numeric value for a Unicode code point as defined in the
-     * Unicode Character Database.</p>
+     * Unicode Character Database.
      * <p>A "double" return type is necessary because some numeric values are
-     * fractions, negative, or too large for int.</p>
+     * fractions, negative, or too large for int.
      * <p>For characters without any numeric values in the Unicode Character
      * Database, this function will return NO_NUMERIC_VALUE.
-     * Note: This is different from the Unicode Standard which specifies NaN as the default value.</p>
+     * Note: This is different from the Unicode Standard which specifies NaN as the default value.
      * <p><em>API Change:</em> In release 2.2 and prior, this API has a
      * return type int and returns -1 when the argument ch does not have a
      * corresponding numeric value. This has been changed to synch with ICU4C
-     * </p>
+     *
      * This corresponds to the ICU4C function u_getNumericValue.
      * @param ch Code point to get the numeric value for.
      * @return numeric value of ch, or NO_NUMERIC_VALUE if none is defined.
@@ -3066,7 +3066,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
      * <em>NOTE:</em> the UCharacterCategory values are <em>not</em> compatible with
      * those returned by java.lang.Character.getType.  UCharacterCategory values
      * match the ones used in ICU4C, while java.lang.Character type
-     * values, though similar, skip the value 17.</p>
+     * values, though similar, skip the value 17.
      * @param ch code point whose type is to be determined
      * @return category which is a value of UCharacterCategory
      */
@@ -3109,8 +3109,8 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     /**
      * Determines if the specified code point is an ISO control character.
      * A code point is considered to be an ISO control character if it is in
-     * the range &#92u0000 through &#92u001F or in the range &#92u007F through
-     * &#92u009F.<br>
+     * the range &#92;u0000 through &#92;u001F or in the range &#92;u007F through
+     * &#92;u009F.<br>
      * Up-to-date Unicode implementation of java.lang.Character.isISOControl()
      * @param ch code point to determine if it is an ISO control character
      * @return true if code point is a ISO control character
@@ -3230,16 +3230,16 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
      * if it satisfies one of the following criteria:
      * <ul>
      * <li> It is a Unicode Separator character (categories "Z" = "Zs" or "Zl" or "Zp"), but is not
-     *      also a non-breaking space (&#92u00A0 or &#92u2007 or &#92u202F).
-     * <li> It is &#92u0009, HORIZONTAL TABULATION.
-     * <li> It is &#92u000A, LINE FEED.
-     * <li> It is &#92u000B, VERTICAL TABULATION.
-     * <li> It is &#92u000C, FORM FEED.
-     * <li> It is &#92u000D, CARRIAGE RETURN.
-     * <li> It is &#92u001C, FILE SEPARATOR.
-     * <li> It is &#92u001D, GROUP SEPARATOR.
-     * <li> It is &#92u001E, RECORD SEPARATOR.
-     * <li> It is &#92u001F, UNIT SEPARATOR.
+     *      also a non-breaking space (&#92;u00A0 or &#92;u2007 or &#92;u202F).
+     * <li> It is &#92;u0009, HORIZONTAL TABULATION.
+     * <li> It is &#92;u000A, LINE FEED.
+     * <li> It is &#92;u000B, VERTICAL TABULATION.
+     * <li> It is &#92;u000C, FORM FEED.
+     * <li> It is &#92;u000D, CARRIAGE RETURN.
+     * <li> It is &#92;u001C, FILE SEPARATOR.
+     * <li> It is &#92;u001D, GROUP SEPARATOR.
+     * <li> It is &#92;u001E, RECORD SEPARATOR.
+     * <li> It is &#92;u001F, UNIT SEPARATOR.
      * </ul>
      *
      * This API tries to sync with the semantics of Java's
@@ -3774,8 +3774,8 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
      * <strong>[icu]</strong> Returns a name for a valid codepoint. Unlike, getName(int) and
      * getName1_0(int), this method will return a name even for codepoints that
      * are not assigned a name in UnicodeData.txt.
-     * </p>
-     * The names are returned in the following order.
+     *
+     * <p>The names are returned in the following order.
      * <ul>
      * <li> Most current Unicode name if there is any
      * <li> Unicode 1.0 name if there is any
@@ -3825,7 +3825,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
 
     /**
      * <strong>[icu]</strong> <p>Finds a Unicode code point by its most current Unicode name and
-     * return its code point value. All Unicode names are in uppercase.</p>
+     * return its code point value. All Unicode names are in uppercase.
      * Note calling any methods related to code point names, e.g. get*Name*()
      * incurs a one-time initialisation cost to construct the name tables.
      * @param name most current Unicode character name whose code point is to
@@ -3840,7 +3840,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     /**
      * <strong>[icu]</strong> Returns -1.
      * <p>Used to find a Unicode character by its version 1.0 Unicode name and return
-     * its code point value.</p>
+     * its code point value.
      * @param name Unicode 1.0 code point name whose code point is to be
      *             returned
      * @return -1
@@ -3857,13 +3857,13 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
      * <strong>[icu]</strong> <p>Find a Unicode character by either its name and return its code
      * point value. All Unicode names are in uppercase.
      * Extended names are all lowercase except for numbers and are contained
-     * within angle brackets.</p>
+     * within angle brackets.
      * The names are searched in the following order
      * <ul>
      * <li> Most current Unicode name if there is any
      * <li> Unicode 1.0 name if there is any
      * <li> Extended name in the form of
-     *      "<codepoint_type-codepoint_hex_digits>". E.g. <noncharacter-FFFE>
+     *      "&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*()
      * incurs a one-time initialisation cost to construct the name tables.
@@ -3878,7 +3878,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
 
     /**
      * <strong>[icu]</strong> <p>Find a Unicode character by its corrected name alias and return
-     * its code point value. All Unicode names are in uppercase.</p>
+     * its code point value. All Unicode names are in uppercase.
      * Note calling any methods related to code point names, e.g. get*Name*()
      * incurs a one-time initialisation cost to construct the name tables.
      * @param name Unicode name alias whose code point is to be returned
@@ -4253,17 +4253,17 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <p>Returns the titlecase version of the argument string.</p>
+     * <p>Returns the titlecase version of the argument string.
      * <p>Position for titlecasing is determined by the argument break
      * iterator, hence the user can customize his break iterator for
      * a specialized titlecasing. In this case only the forward iteration
      * needs to be implemented.
      * If the break iterator passed in is null, the default Unicode algorithm
      * will be used to determine the titlecase positions.
-     * </p>
+     *
      * <p>Only positions returned by the break iterator will be title cased,
-     * character in between the positions will all be in lower case.</p>
-     * <p>Casing is dependent on the default locale and context-sensitive</p>
+     * character in between the positions will all be in lower case.
+     * <p>Casing is dependent on the default locale and context-sensitive
      * @param str source string to be performed on
      * @param breakiter break iterator to determine the positions in which
      *        the character should be title cased.
@@ -4369,17 +4369,17 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <p>Returns the titlecase version of the argument string.</p>
+     * <p>Returns the titlecase version of the argument string.
      * <p>Position for titlecasing is determined by the argument break
      * iterator, hence the user can customize his break iterator for
      * a specialized titlecasing. In this case only the forward iteration
      * needs to be implemented.
      * If the break iterator passed in is null, the default Unicode algorithm
      * will be used to determine the titlecase positions.
-     * </p>
+     *
      * <p>Only positions returned by the break iterator will be title cased,
-     * character in between the positions will all be in lower case.</p>
-     * <p>Casing is dependent on the argument locale and context-sensitive</p>
+     * character in between the positions will all be in lower case.
+     * <p>Casing is dependent on the argument locale and context-sensitive
      * @param locale which string is to be converted in
      * @param str source string to be performed on
      * @param breakiter break iterator to determine the positions in which
@@ -4393,17 +4393,17 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <p>Returns the titlecase version of the argument string.</p>
+     * <p>Returns the titlecase version of the argument string.
      * <p>Position for titlecasing is determined by the argument break
      * iterator, hence the user can customize his break iterator for
      * a specialized titlecasing. In this case only the forward iteration
      * needs to be implemented.
      * If the break iterator passed in is null, the default Unicode algorithm
      * will be used to determine the titlecase positions.
-     * </p>
+     *
      * <p>Only positions returned by the break iterator will be title cased,
-     * character in between the positions will all be in lower case.</p>
-     * <p>Casing is dependent on the argument locale and context-sensitive</p>
+     * character in between the positions will all be in lower case.
+     * <p>Casing is dependent on the argument locale and context-sensitive
      * @param locale which string is to be converted in
      * @param str source string to be performed on
      * @param titleIter break iterator to determine the positions in which
@@ -4416,17 +4416,17 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <p>Returns the titlecase version of the argument string.</p>
+     * <p>Returns the titlecase version of the argument string.
      * <p>Position for titlecasing is determined by the argument break
      * iterator, hence the user can customize his break iterator for
      * a specialized titlecasing. In this case only the forward iteration
      * needs to be implemented.
      * If the break iterator passed in is null, the default Unicode algorithm
      * will be used to determine the titlecase positions.
-     * </p>
+     *
      * <p>Only positions returned by the break iterator will be title cased,
-     * character in between the positions will all be in lower case.</p>
-     * <p>Casing is dependent on the argument locale and context-sensitive</p>
+     * character in between the positions will all be in lower case.
+     * <p>Casing is dependent on the argument locale and context-sensitive
      * @param locale which string is to be converted in
      * @param str source string to be performed on
      * @param titleIter break iterator to determine the positions in which
@@ -4636,17 +4636,17 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     } 
 
     /**
-     * <strong>[icu]</strong> <p>Returns the titlecase version of the argument string.</p>
+     * <strong>[icu]</strong> <p>Returns the titlecase version of the argument string.
      * <p>Position for titlecasing is determined by the argument break
      * iterator, hence the user can customize his break iterator for
      * a specialized titlecasing. In this case only the forward iteration
      * needs to be implemented.
      * If the break iterator passed in is null, the default Unicode algorithm
      * will be used to determine the titlecase positions.
-     * </p>
+     *
      * <p>Only positions returned by the break iterator will be title cased,
-     * character in between the positions will all be in lower case.</p>
-     * <p>Casing is dependent on the argument locale and context-sensitive</p>
+     * character in between the positions will all be in lower case.
+     * <p>Casing is dependent on the argument locale and context-sensitive
      * @param locale which string is to be converted in
      * @param str source string to be performed on
      * @param titleIter break iterator to determine the positions in which
@@ -4863,8 +4863,8 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> <p>Returns an iterator for character types, iterating over codepoints.</p>
-     * Example of use:<br>
+     * <strong>[icu]</strong> <p>Returns an iterator for character types, iterating over codepoints.
+     * <p>Example of use:<br>
      * <pre>
      * RangeValueIterator iterator = UCharacter.getTypeIterator();
      * RangeValueIterator.Element element = new RangeValueIterator.Element();
@@ -4919,11 +4919,11 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> <p>Returns an iterator for character names, iterating over codepoints.</p>
+     * <strong>[icu]</strong> <p>Returns an iterator for character names, iterating over codepoints.
      * <p>This API only gets the iterator for the modern, most up-to-date
      * Unicode names. For older 1.0 Unicode names use get1_0NameIterator() or
-     * for extended names use getExtendedNameIterator().</p>
-     * Example of use:<br>
+     * for extended names use getExtendedNameIterator().
+     * <p>Example of use:<br>
      * <pre>
      * ValueIterator iterator = UCharacter.getNameIterator();
      * ValueIterator.Element element = new ValueIterator.Element();
@@ -4934,7 +4934,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
      * }
      * </pre>
      * <p>The maximal range which the name iterator iterates is from
-     * UCharacter.MIN_VALUE to UCharacter.MAX_VALUE.</p>
+     * UCharacter.MIN_VALUE to UCharacter.MAX_VALUE.
      * @return an iterator
      */
     public static ValueIterator getNameIterator(){
@@ -4944,7 +4944,7 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
 
     /**
      * <strong>[icu]</strong> Returns an empty iterator.
-     * <p>Used to return an iterator for the older 1.0 Unicode character names, iterating over codepoints.</p>
+     * <p>Used to return an iterator for the older 1.0 Unicode character names, iterating over codepoints.
      * @return an empty iterator
      * @deprecated ICU 49
      * @see #getName1_0(int)
@@ -4962,11 +4962,11 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> <p>Returns an iterator for character names, iterating over codepoints.</p>
+     * <strong>[icu]</strong> <p>Returns an iterator for character names, iterating over codepoints.
      * <p>This API only gets the iterator for the extended names.
      * For modern, most up-to-date Unicode names use getNameIterator() or
-     * for older 1.0 Unicode names use get1_0NameIterator().</p>
-     * Example of use:<br>
+     * for older 1.0 Unicode names use get1_0NameIterator().
+     * <p>Example of use:<br>
      * <pre>
      * ValueIterator iterator = UCharacter.getExtendedNameIterator();
      * ValueIterator.Element element = new ValueIterator.Element();
@@ -4985,13 +4985,13 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> Returns the "age" of the code point.</p>
+     * <strong>[icu]</strong> Returns the "age" of the code point.
      * <p>The "age" is the Unicode version when the code point was first
      * designated (as a non-character or for Private Use) or assigned a
      * character.
      * <p>This can be useful to avoid emitting code points to receiving
-     * processes that do not accept newer characters.</p>
-     * <p>The data is from the UCD file DerivedAge.txt.</p>
+     * processes that do not accept newer characters.
+     * <p>The data is from the UCD file DerivedAge.txt.
      * @param ch The code point.
      * @return the Unicode version number
      */
@@ -5004,20 +5004,20 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> <p>Check a binary Unicode property for a code point.</p>
+     * <strong>[icu]</strong> <p>Check a binary Unicode property for a code point.
      * <p>Unicode, especially in version 3.2, defines many more properties
-     * than the original set in UnicodeData.txt.</p>
+     * than the original set in UnicodeData.txt.
      * <p>This API is intended to reflect Unicode properties as defined in
      * the Unicode Character Database (UCD) and Unicode Technical Reports
-     * (UTR).</p>
+     * (UTR).
      * <p>For details about the properties see
-     * <a href=http://www.unicode.org/>http://www.unicode.org/</a>.</p>
+     * <a href=http://www.unicode.org/>http://www.unicode.org/</a>.
      * <p>For names of Unicode properties see the UCD file
-     * PropertyAliases.txt.</p>
-     * <p>This API does not check the validity of the codepoint.</p>
+     * PropertyAliases.txt.
+     * <p>This API does not check the validity of the codepoint.
      * <p>Important: If ICU is built with UCD files from Unicode versions
      * below 3.2, then properties marked with "new" are not or
-     * not fully available.</p>
+     * not fully available.
      * @param ch code point to test.
      * @param property selector constant from android.icu.lang.UProperty,
      *        identifies which binary property to check.
@@ -5033,9 +5033,9 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> <p>Check if a code point has the Alphabetic Unicode property.</p>
-     * <p>Same as UCharacter.hasBinaryProperty(ch, UProperty.ALPHABETIC).</p>
-     * <p>Different from UCharacter.isLetter(ch)!</p>
+     * <strong>[icu]</strong> <p>Check if a code point has the Alphabetic Unicode property.
+     * <p>Same as UCharacter.hasBinaryProperty(ch, UProperty.ALPHABETIC).
+     * <p>Different from UCharacter.isLetter(ch)!
      * @param ch codepoint to be tested
      */
     public static boolean isUAlphabetic(int ch)
@@ -5044,9 +5044,9 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> <p>Check if a code point has the Lowercase Unicode property.</p>
-     * <p>Same as UCharacter.hasBinaryProperty(ch, UProperty.LOWERCASE).</p>
-     * <p>This is different from UCharacter.isLowerCase(ch)!</p>
+     * <strong>[icu]</strong> <p>Check if a code point has the Lowercase Unicode property.
+     * <p>Same as UCharacter.hasBinaryProperty(ch, UProperty.LOWERCASE).
+     * <p>This is different from UCharacter.isLowerCase(ch)!
      * @param ch codepoint to be tested
      */
     public static boolean isULowercase(int ch)
@@ -5055,9 +5055,9 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> <p>Check if a code point has the Uppercase Unicode property.</p>
-     * <p>Same as UCharacter.hasBinaryProperty(ch, UProperty.UPPERCASE).</p>
-     * <p>This is different from UCharacter.isUpperCase(ch)!</p>
+     * <strong>[icu]</strong> <p>Check if a code point has the Uppercase Unicode property.
+     * <p>Same as UCharacter.hasBinaryProperty(ch, UProperty.UPPERCASE).
+     * <p>This is different from UCharacter.isUpperCase(ch)!
      * @param ch codepoint to be tested
      */
     public static boolean isUUppercase(int ch)
@@ -5066,10 +5066,10 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
     }
 
     /**
-     * <strong>[icu]</strong> <p>Check if a code point has the White_Space Unicode property.</p>
-     * <p>Same as UCharacter.hasBinaryProperty(ch, UProperty.WHITE_SPACE).</p>
+     * <strong>[icu]</strong> <p>Check if a code point has the White_Space Unicode property.
+     * <p>Same as UCharacter.hasBinaryProperty(ch, UProperty.WHITE_SPACE).
      * <p>This is different from both UCharacter.isSpace(ch) and
-     * UCharacter.isWhitespace(ch)!</p>
+     * UCharacter.isWhitespace(ch)!
      * @param ch codepoint to be tested
      */
     public static boolean isUWhiteSpace(int ch)
@@ -5079,15 +5079,15 @@ public final class UCharacter implements ECharacterCategory, ECharacterDirection
 
     /**
      * <strong>[icu]</strong> <p>Returns the property value for an Unicode property type of a code point.
-     * Also returns binary and mask property values.</p>
+     * Also returns binary and mask property values.
      * <p>Unicode, especially in version 3.2, defines many more properties than
-     * the original set in UnicodeData.txt.</p>
+     * the original set in UnicodeData.txt.
      * <p>The properties APIs are intended to reflect Unicode properties as
      * defined in the Unicode Character Database (UCD) and Unicode Technical
      * Reports (UTR). For details about the properties see
-     * http://www.unicode.org/.</p>
+     * http://www.unicode.org/.
      * <p>For names of Unicode properties see the UCD file PropertyAliases.txt.
-     * </p>
+     *
      * <pre>
      * Sample usage:
      * int ea = UCharacter.getIntPropertyValue(c, UProperty.EAST_ASIAN_WIDTH);
-- 
cgit v1.2.3