organicmaps/icu
13
Fork 0
mirror of https://github.com/unicode-org/icu.git synced 2025-04-08 06:53:45 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions 2

ICU-3820 fix doxygen warnings.

Browse source 
X-SVN-Rev: 15879
This commit is contained in:
Eric Mader 2004-06-15 20:52:22 +00:00
parent b9880da9fa
commit ad42df258f
30 changed files with 154 additions and 120 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
icu4c/source/common/unicode/caniter.h
View file

@ -31,29 +31,29 @@ class Hashtable;
* This class allows one to iterate through all the strings that are canonically equivalent to a given
* string. For example, here are some sample results:
Results for: {LATIN CAPITAL LETTER A WITH RING ABOVE}{LATIN SMALL LETTER D}{COMBINING DOT ABOVE}{COMBINING CEDILLA}
1: \u0041\u030A\u0064\u0307\u0327
1: \\u0041\\u030A\\u0064\\u0307\\u0327
= {LATIN CAPITAL LETTER A}{COMBINING RING ABOVE}{LATIN SMALL LETTER D}{COMBINING DOT ABOVE}{COMBINING CEDILLA}
2: \u0041\u030A\u0064\u0327\u0307
2: \\u0041\\u030A\\u0064\\u0327\\u0307
= {LATIN CAPITAL LETTER A}{COMBINING RING ABOVE}{LATIN SMALL LETTER D}{COMBINING CEDILLA}{COMBINING DOT ABOVE}
3: \u0041\u030A\u1E0B\u0327
3: \\u0041\\u030A\\u1E0B\\u0327
= {LATIN CAPITAL LETTER A}{COMBINING RING ABOVE}{LATIN SMALL LETTER D WITH DOT ABOVE}{COMBINING CEDILLA}
4: \u0041\u030A\u1E11\u0307
4: \\u0041\\u030A\\u1E11\\u0307
= {LATIN CAPITAL LETTER A}{COMBINING RING ABOVE}{LATIN SMALL LETTER D WITH CEDILLA}{COMBINING DOT ABOVE}
5: \u00C5\u0064\u0307\u0327
5: \\u00C5\\u0064\\u0307\\u0327
= {LATIN CAPITAL LETTER A WITH RING ABOVE}{LATIN SMALL LETTER D}{COMBINING DOT ABOVE}{COMBINING CEDILLA}
6: \u00C5\u0064\u0327\u0307
6: \\u00C5\\u0064\\u0327\\u0307
= {LATIN CAPITAL LETTER A WITH RING ABOVE}{LATIN SMALL LETTER D}{COMBINING CEDILLA}{COMBINING DOT ABOVE}
7: \u00C5\u1E0B\u0327
7: \\u00C5\\u1E0B\\u0327
= {LATIN CAPITAL LETTER A WITH RING ABOVE}{LATIN SMALL LETTER D WITH DOT ABOVE}{COMBINING CEDILLA}
8: \u00C5\u1E11\u0307
8: \\u00C5\\u1E11\\u0307
= {LATIN CAPITAL LETTER A WITH RING ABOVE}{LATIN SMALL LETTER D WITH CEDILLA}{COMBINING DOT ABOVE}
9: \u212B\u0064\u0307\u0327
9: \\u212B\\u0064\\u0307\\u0327
= {ANGSTROM SIGN}{LATIN SMALL LETTER D}{COMBINING DOT ABOVE}{COMBINING CEDILLA}
10: \u212B\u0064\u0327\u0307
10: \\u212B\\u0064\\u0327\\u0307
= {ANGSTROM SIGN}{LATIN SMALL LETTER D}{COMBINING CEDILLA}{COMBINING DOT ABOVE}
11: \u212B\u1E0B\u0327
11: \\u212B\\u1E0B\\u0327
= {ANGSTROM SIGN}{LATIN SMALL LETTER D WITH DOT ABOVE}{COMBINING CEDILLA}
12: \u212B\u1E11\u0307
12: \\u212B\\u1E11\\u0307
= {ANGSTROM SIGN}{LATIN SMALL LETTER D WITH CEDILLA}{COMBINING DOT ABOVE}
*<br>Note: the code is intended for use with small strings, and is not suitable for larger ones,
* since it has not been optimized for that situation.

6
icu4c/source/common/unicode/ubrk.h
View file

@ -396,8 +396,8 @@ ubrk_setText(UBreakIterator* bi,
* Determine the most recently-returned text boundary.
*
* @param bi The break iterator to use.
* @return The character index most recently returned by \Ref{ubrk_next}, \Ref{ubrk_previous},
* \Ref{ubrk_first}, or \Ref{ubrk_last}.
* @return The character index most recently returned by \ref ubrk_next, \ref ubrk_previous,
* \ref ubrk_first, or \ref ubrk_last.
* @stable ICU 2.0
*/
U_STABLE int32_t U_EXPORT2
@ -492,7 +492,7 @@ ubrk_getAvailable(int32_t index);
/**
* Determine how many locales have text breaking information available.
* This function is most useful as determining the loop ending condition for
* calls to \Ref{ubrk_getAvailable}.
* calls to \ref ubrk_getAvailable.
* @return The number of locales for which text breaking information is available.
* @see ubrk_getAvailable
* @stable ICU 2.0

2
icu4c/source/common/unicode/ucat.h
View file

@ -26,7 +26,7 @@
* The ICU resource bundles obey standard ICU inheritance policies.
* To facilitate this, sets and messages are flattened into one tier.
* This is done by creating resource bundle keys of the form
* <set_num>%<msg_num> where set_num is the set number and msg_num is
* &lt;set_num&gt;%&lt;msg_num&gt; where set_num is the set number and msg_num is
* the message number, formatted as decimal strings.
*
* Example: Consider a message catalog containing two sets:

1
icu4c/source/common/unicode/ucnv.h
View file

@ -69,6 +69,7 @@ typedef struct UConverter UConverter;
* @draft ICU 2.6
*/
struct USet;
/** @draft ICU 2.6 */
typedef struct USet USet;
#endif

22
icu4c/source/common/unicode/ucnv_err.h
View file

@ -110,13 +110,13 @@
*/
#define UCNV_ESCAPE_ICU NULL
/**
* FROM_U_CALLBACK_ESCAPE context option to escape the code unit according to JAVA (\uXXXX)
* FROM_U_CALLBACK_ESCAPE context option to escape the code unit according to JAVA (\\uXXXX)
* @stable ICU 2.0
*/
#define UCNV_ESCAPE_JAVA "J"
/**
* FROM_U_CALLBACK_ESCAPE context option to escape the code unit according to C (\uXXXX \UXXXXXXXX)
* TO_U_CALLBACK_ESCAPE option to escape the character value accoding to C (\xXXXX)
* FROM_U_CALLBACK_ESCAPE context option to escape the code unit according to C (\\uXXXX \\UXXXXXXXX)
* TO_U_CALLBACK_ESCAPE option to escape the character value accoding to C (\\xXXXX)
* @stable ICU 2.0
*/
#define UCNV_ESCAPE_C "C"
@ -148,15 +148,15 @@ typedef enum {
UCNV_UNASSIGNED = 0, /**< The code point is unassigned.
The error code U_INVALID_CHAR_FOUND will be set. */
UCNV_ILLEGAL = 1, /**< The code point is illegal. For example,
\x81\x2E is illegal in SJIS because \x2E
is not a valid trail byte for the \x81
\\x81\\x2E is illegal in SJIS because \\x2E
is not a valid trail byte for the \\x81
lead byte.
Also, starting with Unicode 3.0.1, non-shortest byte sequences
in UTF-8 (like \xC1\xA1 instead of \x61 for U+0061)
in UTF-8 (like \\xC1\\xA1 instead of \\x61 for U+0061)
are also illegal, not just irregular.
The error code U_ILLEGAL_CHAR_FOUND will be set. */
UCNV_IRREGULAR = 2, /**< The codepoint is not a regular sequence in
the encoding. For example, \xED\xA0\x80..\xED\xBF\xBF
the encoding. For example, \\xED\\xA0\\x80..\\xED\\xBF\\xBF
are irregular UTF-8 byte sequences for single surrogate
code points.
The error code U_INVALID_CHAR_FOUND will be set. */
@ -327,17 +327,17 @@ U_STABLE void U_EXPORT2 UCNV_FROM_U_CALLBACK_SUBSTITUTE (
* Note that codeUnit(32bit int eg: unit of a surrogate pair) is represented as
* %UD84D%UDC56</li>
* <li>UCNV_ESCAPE_JAVA: Substitues the ILLEGAL SEQUENCE with the hexadecimal
* representation in the format \uXXXX, e.g. "\uFFFE\u00AC\uC8FE").
* representation in the format \\uXXXX, e.g. "\\uFFFE\\u00AC\\uC8FE").
* In the Event the converter doesn't support the characters {\,u}[A-F][0-9],
* it will substitute the illegal sequence with the substitution characters.
* Note that codeUnit(32bit int eg: unit of a surrogate pair) is represented as
* \uD84D\uDC56</li>
* \\uD84D\\uDC56</li>
* <li>UCNV_ESCAPE_C: Substitues the ILLEGAL SEQUENCE with the hexadecimal
* representation in the format \uXXXX, e.g. "\uFFFE\u00AC\uC8FE").
* representation in the format \\uXXXX, e.g. "\\uFFFE\\u00AC\\uC8FE").
* In the Event the converter doesn't support the characters {\,u,U}[A-F][0-9],
* it will substitute the illegal sequence with the substitution characters.
* Note that codeUnit(32bit int eg: unit of a surrogate pair) is represented as
* \U00023456</li>
* \\U00023456</li>
* <li>UCNV_ESCAPE_XML_DEC: Substitues the ILLEGAL SEQUENCE with the decimal
* representation in the format &amp;#DDDDDDDD;, e.g. "&amp;#65534;&amp;#172;&amp;#51454;").
* In the Event the converter doesn't support the characters {&amp;,#}[0-9],

5
icu4c/source/common/unicode/uconfig.h
View file

@ -158,10 +158,11 @@
# define UCONFIG_NO_REGULAR_EXPRESSIONS 0
#endif
/**
/*
* \def UCONFIG_NO_SERVICE
* This switch turns off service registration.
* note: NOT implemented in ICU 3.0.
* note: NOT implemented in ICU 3.0.
* note: Change this back to a .doc comment when this is implemented!
*
* @internal ICU 3.0
*/

1
icu4c/source/common/unicode/udata.h
View file

@ -62,6 +62,7 @@ U_CDECL_BEGIN
/**
* Alias for standard ICU data
* @draft ICU 3.0
*/
#define U_ICUDATA_ALIAS "ICUDATA"

4
icu4c/source/common/unicode/uenum.h
View file

@ -64,7 +64,7 @@ uenum_count(UEnumeration* en, UErrorCode* status);
* The result is terminated by (UChar)0.
* @param en the iterator object
* @param resultLength pointer to receive the length of the result
* (not including the terminating \0).
* (not including the terminating \\0).
* If the pointer is NULL it is ignored.
* @param status the error code, set to U_ENUM_OUT_OF_SYNC_ERROR if
* the iterator is out of sync with its service.
@ -93,7 +93,7 @@ uenum_unext(UEnumeration* en,
* (but non-NULL).
* @param en the iterator object
* @param resultLength pointer to receive the length of the result
* (not including the terminating \0).
* (not including the terminating \\0).
* If the pointer is NULL it is ignored.
* @param status the error code, set to U_ENUM_OUT_OF_SYNC_ERROR if
* the iterator is out of sync with its service. Set to

12
icu4c/source/common/unicode/uloc.h
View file

@ -181,9 +181,9 @@
* <P>
* Concerning POSIX/RFC1766 Locale IDs,
* the getLanguage/getCountry/getVariant/getName functions do understand
* the POSIX type form of language_COUNTRY.ENCODING@VARIANT
* the POSIX type form of language_COUNTRY.ENCODING\@VARIANT
* and if there is not an ICU-stype variant, uloc_getVariant() for example
* will return the one listed after the @at sign. As well, the hyphen
* will return the one listed after the \@at sign. As well, the hyphen
* "-" is recognized as a country/variant separator similarly to RFC1766.
* So for example, "en-us" will be interpreted as en_US.
* As a result, uloc_getName() is far from a no-op, and will have the
@ -192,7 +192,7 @@
* Applications should call uloc_getName() at the point where a locale ID
* is coming from an external source (user entry, OS, web browser)
* and pass the resulting string to other ICU functions. For example,
* don't use de-de@EURO as an argument to resourcebundle.
* don't use de-de\@EURO as an argument to resourcebundle.
*
* @see UResourceBundle
*/
@ -617,7 +617,7 @@ uloc_getDisplayVariant(const char* locale,
/**
* Gets the keyword name suitable for display for the specified locale.
* E.g: for the locale string de_DE@collation=PHONEBOOK, this API gets the display
* E.g: for the locale string de_DE\@collation=PHONEBOOK, this API gets the display
* string for the keyword collation.
* Usage:
* <code>
@ -663,7 +663,7 @@ uloc_getDisplayKeyword(const char* keyword,
UErrorCode* status);
/**
* Gets the value of the keyword suitable for display for the specified locale.
* E.g: for the locale string de_DE@collation=PHONEBOOK, this API gets the display
* E.g: for the locale string de_DE\@collation=PHONEBOOK, this API gets the display
* string for PHONEBOOK, in the display locale, when "collation" is specified as the keyword.
*
* @param locale The locale to get the displayable variant code with. NULL may be used to specify the default.
@ -786,7 +786,7 @@ uloc_getParent(const char* localeID,
* and if the components were in 'POSIX' format they are changed to
* ICU format. It does NOT map aliased names in any way.
* See the top of this header file.
* This API strips off the keyword part, so "de_DE@collation=phonebook"
* This API strips off the keyword part, so "de_DE\@collation=phonebook"
* will become "de_DE".
* This API supports preflighting.
*

1
icu4c/source/common/unicode/unifilt.h
View file

@ -20,6 +20,7 @@ U_NAMESPACE_BEGIN
* characters outside the range contextStart..contextLimit-1. This
* allows explicit matching by rules and UnicodeSets of text outside a
* defined range.
* @draft ICU 3.0
*/
#define U_ETHER ((UChar)0xFFFF)

4
icu4c/source/common/unicode/unimatch.h
View file

@ -126,8 +126,8 @@ public:
* @param result the string to receive the pattern. Previous
* contents will be deleted.
* @param escapeUnprintable if TRUE then convert unprintable
* character to their hex escape representations, \uxxxx or
* \Uxxxxxxxx. Unprintable characters are those other than
* character to their hex escape representations, \\uxxxx or
* \\Uxxxxxxxx. Unprintable characters are those other than
* U+000A, U+0020..U+007E.
* @stable ICU 2.4
*/

42
icu4c/source/common/unicode/uniset.h
View file

@ -86,7 +86,7 @@ class RuleCharacterIterator;
* point order</td>
* </tr>
* <tr>
* <td nowrap valign="top" align="left"><code>[\u4E01]</code></td>
* <td nowrap valign="top" align="left"><code>[\\u4E01]</code></td>
* <td valign="top">The character U+4E01</td>
* </tr>
* <tr>
@ -95,7 +95,7 @@ class RuleCharacterIterator;
* &quot;ac&quot;</td>
* </tr>
* <tr>
* <td nowrap valign="top" align="left"><code>[\p{Lu}]</code></td>
* <td nowrap valign="top" align="left"><code>[\\p{Lu}]</code></td>
* <td valign="top">All characters in the general category Uppercase Letter</td>
* </tr>
* </table>
@ -107,7 +107,7 @@ class RuleCharacterIterator;
*
* <p>Property patterns specify a set of characters having a certain
* property as defined by the Unicode standard. Both the POSIX-like
* "[:Lu:]" and the Perl-like syntax "\p{Lu}" are recognized. For a
* "[:Lu:]" and the Perl-like syntax "\\p{Lu}" are recognized. For a
* complete list of supported property patterns, see the User's Guide
* for UnicodeSet at
* <a href="http://oss.software.ibm.com/icu/userguide/unicodeSet.html">
@ -119,7 +119,7 @@ class RuleCharacterIterator;
* Unicode property sets. When elements are concatenated, they
* specify their union. To complement a set, place a '^' immediately
* after the opening '['. Property patterns are inverted by modifying
* their delimiters; "[:^foo]" and "\P{foo}". In any other location,
* their delimiters; "[:^foo]" and "\\P{foo}". In any other location,
* '^' has no special meaning.
*
* <p>Ranges are indicated by placing two a '-' between two
@ -134,11 +134,11 @@ class RuleCharacterIterator;
*
* <p>Sets may be intersected using the '&' operator or the asymmetric
* set difference may be taken using the '-' operator, for example,
* "[[:L:]&[\u0000-\u0FFF]]" indicates the set of all Unicode letters
* "[[:L:]&[\\u0000-\\u0FFF]]" indicates the set of all Unicode letters
* with values less than 4096. Operators ('&' and '|') have equal
* precedence and bind left-to-right. Thus
* "[[:L:]-[a-z]-[\u0100-\u01FF]]" is equivalent to
* "[[[:L:]-[a-z]]-[\u0100-\u01FF]]". This only really matters for
* "[[:L:]-[a-z]-[\\u0100-\\u01FF]]" is equivalent to
* "[[[:L:]-[a-z]]-[\\u0100-\\u01FF]]". This only really matters for
* difference; intersection is commutative.
*
* <table>
@ -155,11 +155,11 @@ class RuleCharacterIterator;
* <tr valign=top><td nowrap><code>[[<em>pat1</em>]-[<em>pat2</em>]]</code>
* <td>The asymmetric difference of sets specified by <em>pat1</em> and
* <em>pat2</em>
* <tr valign=top><td nowrap><code>[:Lu:] or \p{Lu}</code>
* <tr valign=top><td nowrap><code>[:Lu:] or \\p{Lu}</code>
* <td>The set of characters having the specified
* Unicode property; in
* this case, Unicode uppercase letters
* <tr valign=top><td nowrap><code>[:^Lu:] or \P{Lu}</code>
* <tr valign=top><td nowrap><code>[:^Lu:] or \\P{Lu}</code>
* <td>The set of characters <em>not</em> having the given
* Unicode property
* </table>
@ -200,7 +200,7 @@ class RuleCharacterIterator;
* <td nowrap valign="top" align="right"><code>char :=&nbsp; </code></td>
* <td valign="top"><em>any character that is not</em><code> special<br>
* | ('\' </code><em>any character</em><code>)<br>
* | ('\u' hex hex hex hex)<br>
* | ('\\u' hex hex hex hex)<br>
* </code></td>
* </tr>
* <tr align="top">
@ -531,8 +531,8 @@ public:
* @param result the string to receive the rules. Previous
* contents will be deleted.
* @param escapeUnprintable if TRUE then convert unprintable
* character to their hex escape representations, \uxxxx or
* \Uxxxxxxxx. Unprintable characters are those other than
* character to their hex escape representations, \\uxxxx or
* \\Uxxxxxxxx. Unprintable characters are those other than
* U+000A, U+0020..U+007E.
* @stable ICU 2.0
*/
@ -576,8 +576,8 @@ public:
* property alias, or a special ID. Special IDs are matched loosely and
* correspond to the following sets:
*
* "ANY" = [\u0000-\U0010FFFF],
* "ASCII" = [\u0000-\u007F].
* "ANY" = [\\u0000-\\U0010FFFF],
* "ASCII" = [\\u0000-\\u007F].
*
* @param value a value alias, either short or long. The name is matched
* loosely. See PropertyValueAliases.txt for names and a description of
@ -1054,7 +1054,7 @@ public:
* 2. For each string 'e' in the resulting set, if e !=
* foldCase(e), 'e' will be removed.
*
* Example: [aq\u00DF{Bc}{bC}{Fi}] => [aAqQ\u00DF\uFB01{ss}{bc}{fi}]
* Example: [aq\\u00DF{Bc}{bC}{Fi}] => [aAqQ\\u00DF\\uFB01{ss}{bc}{fi}]
*
* (Here foldCase(x) refers to the operation u_strFoldCase, and a
* == b denotes that the contents are the same, not pointer
@ -1244,8 +1244,8 @@ private:
/**
* Return true if the given position, in the given pattern, appears
* to be the start of a property set pattern [:foo:], \p{foo}, or
* \P{foo}, or \N{name}.
* to be the start of a property set pattern [:foo:], \\p{foo}, or
* \\P{foo}, or \\N{name}.
*/
static UBool resemblesPropertyPattern(const UnicodeString& pattern,
int32_t pos);
@ -1264,11 +1264,11 @@ private:
* Recognized syntax:
*
* [:foo:] [:^foo:] - white space not allowed within "[:" or ":]"
* \p{foo} \P{foo} - white space not allowed within "\p" or "\P"
* \N{name} - white space not allowed within "\N"
* \\p{foo} \\P{foo} - white space not allowed within "\\p" or "\\P"
* \\N{name} - white space not allowed within "\\N"
*
* Other than the above restrictions, white space is ignored. Case
* is ignored except in "\p" and "\P" and "\N". In 'name' leading
* is ignored except in "\\p" and "\\P" and "\\N". In 'name' leading
* and trailing space is deleted, and internal runs of whitespace
* are collapsed to a single space.
*
@ -1283,7 +1283,7 @@ private:
* @param ppos on entry, the position at which to begin parsing.
* This should be one of the locations marked '^':
*
* [:blah:] \p{blah} \P{blah} \N{name}
* [:blah:] \\p{blah} \\P{blah} \\N{name}
* ^ % ^ % ^ % ^ %
*
* On return, the position after the last character parsed, that is,

22
icu4c/source/common/unicode/unistr.h
View file

@ -108,7 +108,7 @@ class BreakIterator; // unicode/brkiter.h
*
* <p>In ICU, a Unicode string consists of 16-bit Unicode <em>code units</em>.
* A Unicode character may be stored with either
* one code unit &mdash; which is the most common case &mdash; or with a matched pair of
* one code unit &#8212; which is the most common case &#8212; or with a matched pair of
* special code units ("surrogates").
* The data type for code units is UChar.<br>
* For single-character handling, a Unicode character code <em>point</em> is a value
@ -2762,23 +2762,23 @@ public:
* Unescape a string of characters and return a string containing
* the result. The following escape sequences are recognized:
*
* \uhhhh 4 hex digits; h in [0-9A-Fa-f]
* \Uhhhhhhhh 8 hex digits
* \xhh 1-2 hex digits
* \ooo 1-3 octal digits; o in [0-7]
* \cX control-X; X is masked with 0x1F
* \\uhhhh 4 hex digits; h in [0-9A-Fa-f]
* \\Uhhhhhhhh 8 hex digits
* \\xhh 1-2 hex digits
* \\ooo 1-3 octal digits; o in [0-7]
* \\cX control-X; X is masked with 0x1F
*
* as well as the standard ANSI C escapes:
*
* \a => U+0007, \b => U+0008, \t => U+0009, \n => U+000A,
* \v => U+000B, \f => U+000C, \r => U+000D, \e => U+001B,
* \" => U+0022, \' => U+0027, \? => U+003F, \\ => U+005C
* \\a => U+0007, \\b => U+0008, \\t => U+0009, \\n => U+000A,
* \\v => U+000B, \\f => U+000C, \\r => U+000D, \\e => U+001B,
* \\" => U+0022, \\' => U+0027, \\? => U+003F, \\\\ => U+005C
*
* Anything else following a backslash is generically escaped. For
* example, "[a\-z]" returns "[a-z]".
* example, "[a\\-z]" returns "[a-z]".
*
* If an escape sequence is ill-formed, this method returns an empty
* string. An example of an ill-formed sequence is "\u" followed by
* string. An example of an ill-formed sequence is "\\u" followed by
* fewer than 4 hex digits.
*
* This function is similar to u_unescape() but not identical to it.

2
icu4c/source/common/unicode/unorm.h
View file

@ -31,7 +31,7 @@
* decomposed form, allowing for easier sorting and searching of text.
* <code>unorm_normalize</code> supports the standard normalization forms described in
* <a href="http://www.unicode.org/unicode/reports/tr15/" target="unicode">
* Unicode Standard Annex #15 &mdash; Unicode Normalization Forms</a>.
* Unicode Standard Annex #15 &#8212; Unicode Normalization Forms</a>.
*
* Characters with accents or other adornments can be encoded in
* several different ways in Unicode. For example, take the character A-acute.

2
icu4c/source/common/unicode/ures.h
View file

@ -701,7 +701,7 @@ ures_openAvailableLocales(const char *path, UErrorCode *status);
* @param isAvailable If non-null, pointer to fillin parameter that indicates whether the
* requested locale was available. The locale is defined as 'available' if it physically
* exists within the specified tree.
* @param omitDefault if TRUE, omit keyword and value if default. 'de_DE@collation=standard' -> 'de_DE'
* @param omitDefault if TRUE, omit keyword and value if default. 'de_DE\@collation=standard' -> 'de_DE'
* @param status error code
* @return the actual buffer size needed for the full locale. If it's greater
* than resultCapacity, the returned full name will be truncated and an error code will be returned.

4
icu4c/source/common/unicode/uset.h
View file

@ -188,8 +188,8 @@ uset_applyPattern(USet *set,
* @param result the string to receive the rules, may be NULL
* @param resultCapacity the capacity of result, may be 0 if result is NULL
* @param escapeUnprintable if TRUE then convert unprintable
* character to their hex escape representations, \uxxxx or
* \Uxxxxxxxx. Unprintable characters are those other than
* character to their hex escape representations, \\uxxxx or
* \\Uxxxxxxxx. Unprintable characters are those other than
* U+000A, U+0020..U+007E.
* @param ec error code.
* @return length of string, possibly larger than resultCapacity

22
icu4c/source/common/unicode/ustring.h
View file

@ -927,24 +927,24 @@ u_memrchr32(const UChar *s, UChar32 c, int32_t count);
* Unicode characters to the destination buffer. The following escape
* sequences are recognized:
*
* \uhhhh 4 hex digits; h in [0-9A-Fa-f]
* \Uhhhhhhhh 8 hex digits
* \xhh 1-2 hex digits
* \x{h...} 1-8 hex digits
* \ooo 1-3 octal digits; o in [0-7]
* \cX control-X; X is masked with 0x1F
* \\uhhhh 4 hex digits; h in [0-9A-Fa-f]
* \\Uhhhhhhhh 8 hex digits
* \\xhh 1-2 hex digits
* \\x{h...} 1-8 hex digits
* \\ooo 1-3 octal digits; o in [0-7]
* \\cX control-X; X is masked with 0x1F
*
* as well as the standard ANSI C escapes:
*
* \a => U+0007, \b => U+0008, \t => U+0009, \n => U+000A,
* \v => U+000B, \f => U+000C, \r => U+000D, \e => U+001B,
* \" => U+0022, \' => U+0027, \? => U+003F, \\ => U+005C
* \\a => U+0007, \\b => U+0008, \\t => U+0009, \\n => U+000A,
* \\v => U+000B, \\f => U+000C, \\r => U+000D, \\e => U+001B,
* \\" => U+0022, \\' => U+0027, \\? => U+003F, \\\\ => U+005C
*
* Anything else following a backslash is generically escaped. For
* example, "[a\-z]" returns "[a-z]".
* example, "[a\\-z]" returns "[a-z]".
*
* If an escape sequence is ill-formed, this method returns an empty
* string. An example of an ill-formed sequence is "\u" followed by
* string. An example of an ill-formed sequence is "\\u" followed by
* fewer than 4 hex digits.
*
* The above characters are recognized in the compiler's codepage,

4
icu4c/source/common/unicode/utf_old.h
View file

@ -84,8 +84,8 @@
* accordingly. UTF-16 was the default.</p>
*
* <p>This concept has been abandoned.
* A lot of the ICU source code &mdash; especially low-level code like
* conversion, normalization, and collation &mdash; assumes UTF-16,
* A lot of the ICU source code &#8212; especially low-level code like
* conversion, normalization, and collation &#8212; assumes UTF-16,
* utf.h enforces the default of UTF-16.
* The UTF-8 and UTF-32 macros remain for now for completeness and backward compatibility.</p>
*

9
icu4c/source/common/unicode/utypes.h
View file

@ -88,7 +88,7 @@
*
* <p>Those "invariant characters" should be all the uppercase and lowercase
* latin letters, the digits, the space, and "basic punctuation".
* Also, '\n', '\r', '\t' should be available.</p>
* Also, '\\n', '\\r', '\\t' should be available.</p>
*
* <p>The list of "invariant characters" is:<br>
* \code
@ -314,6 +314,13 @@ typedef void* UClassID;
* @stable ICU 2.0
*/
/**
* \def U_DATA_API
* Set to export library symbols from inside the stubdata library,
* and to import them from outside.
* @draft ICU 3.0
*/
/**
* \def U_COMMON_API
* Set to export library symbols from inside the common library,

11
icu4c/source/i18n/unicode/calendar.h
View file

@ -1132,7 +1132,7 @@ public:
* Concrete subclasses of Calendar must implement getDynamicClassID() and also a
* static method and data member:
*
* static UClassID getStaticClassID() { return (UClassID)&fgClassID; }
* static UClassID getStaticClassID() { return (UClassID)&amp;fgClassID; }
* static char fgClassID;
*
* @return The class ID for this object. All objects of a given class have the
@ -1583,6 +1583,7 @@ protected:
* computed. This occurs only in setTimeInMillis(). A calendar set
* to this state will compute all fields from the time if it becomes
* necessary, but otherwise will delay such computation.
* @draft ICU 3.0
*/
UBool fAreFieldsVirtuallySet;
@ -1790,6 +1791,8 @@ protected:
* the first week because
* {@link #getMinimalDaysInFirstWeek getMinimalDaysInFirstWeek}
* is more than one.
*
* @draft ICU 2.8
*/
int32_t weekNumber(int32_t desiredDay, int32_t dayOfPeriod, int32_t dayOfWeek);
@ -1974,7 +1977,7 @@ private:
* #validateField(int)} on each field that has been set. This method
* should only be called if this calendar is not lenient.
* @see #isLenient
* @see #validateField(int)
* @see #validateField(int, int&)
* @internal
*/
void validateFields(UErrorCode &status);
@ -1984,7 +1987,7 @@ private:
* override this method to validate any calendar-specific fields.
* Generic fields can be handled by
* <code>Calendar.validateField()</code>.
* @see #validateField(int, int, int)
* @see #validateField(int, int, int, int&)
* @internal
*/
virtual void validateField(UCalendarDateFields field, UErrorCode &status);
@ -1994,7 +1997,7 @@ private:
* maximum allowed value. If the field is out of range,
* <code>U_ILLEGAL_ARGUMENT_ERROR</code> will be set. Subclasses may
* use this method in their implementation of {@link
* #validateField(int)}.
* #validateField(int, int&)}.
* @internal
*/
void validateField(UCalendarDateFields field, int32_t min, int32_t max, UErrorCode& status);

29
icu4c/source/i18n/unicode/decimfmt.h
View file

@ -189,17 +189,17 @@ class ChoiceFormat;
* <td>Yes
* <td>Separates positive and negative subpatterns
* <tr valign=top>
* <td><code>%</code>
* <td><code>\%</code>
* <td>Prefix or suffix
* <td>Yes
* <td>Multiply by 100 and show as percentage
* <tr valign=top bgcolor="#eeeeff">
* <td><code>\u2030</code>
* <td><code>\\u2030</code>
* <td>Prefix or suffix
* <td>Yes
* <td>Multiply by 1000 and show as per mille
* <tr valign=top>
* <td><code>\htmlonly&curren;\endhtmlonly</code> (<code>\u00A4</code>)
* <td><code>\htmlonly&curren;\endhtmlonly</code> (<code>\\u00A4</code>)
* <td>Prefix or suffix
* <td>No
* <td>Currency sign, replaced by currency symbol. If
@ -266,14 +266,14 @@ class ChoiceFormat;
* pattern := subpattern (';' subpattern)?
* subpattern := prefix? number exponent? suffix?
* number := (integer ('.' fraction)?) | sigDigits
* prefix := '\u0000'..'\uFFFD' - specialCharacters
* suffix := '\u0000'..'\uFFFD' - specialCharacters
* prefix := '\\u0000'..'\\uFFFD' - specialCharacters
* suffix := '\\u0000'..'\\uFFFD' - specialCharacters
* integer := '#'* '0'* '0'
* fraction := '0'* '#'*
* sigDigits := '#'* '@' '@'* '#'*
* exponent := 'E' '+'? '0'* '0'
* padSpec := '*' padChar
* padChar := '\u0000'..'\uFFFD' - quote
* padChar := '\\u0000'..'\\uFFFD' - quote
* &nbsp;
* Notation:
* X* 0 or more instances of X
@ -361,12 +361,12 @@ class ChoiceFormat;
* <p><strong>Special Values</strong>
*
* <p><code>NaN</code> is represented as a single character, typically
* <code>\uFFFD</code>. This character is determined by the
* <code>\\uFFFD</code>. This character is determined by the
* DecimalFormatSymbols object. This is the only value for which
* the prefixes and suffixes are not used.
*
* <p>Infinity is represented as a single character, typically
* <code>\u221E</code>, with the positive or negative prefixes and suffixes
* <code>\\u221E</code>, with the positive or negative prefixes and suffixes
* applied. The infinity character is determined by the
* DecimalFormatSymbols object.
*
@ -444,25 +444,25 @@ class ChoiceFormat;
* <td align=left>Number
* <td align=left>Output of format()
* <tr valign=top>
* <td><code>@@@</code>
* <td><code>\@\@\@</code>
* <td>3
* <td>3
* <td>12345
* <td><code>12300</code>
* <tr valign=top bgcolor="#eeeeff">
* <td><code>@@@</code>
* <td><code>\@\@\@</code>
* <td>3
* <td>3
* <td>0.12345
* <td><code>0.123</code>
* <tr valign=top>
* <td><code>@@##</code>
* <td><code>\@\@##</code>
* <td>2
* <td>4
* <td>3.14159
* <td><code>3.142</code>
* <tr valign=top bgcolor="#eeeeff">
* <td><code>@@##</code>
* <td><code>\@\@##</code>
* <td>2
* <td>4
* <td>1.23004
@ -1046,7 +1046,7 @@ public:
* Get the multiplier for use in percent, permill, etc.
* For a percentage, set the suffixes to have "%" and the multiplier to be 100.
* (For Arabic, use arabic percent symbol).
* For a permill, set the suffixes to have "\u2031" and the multiplier to be 1000.
* For a permill, set the suffixes to have "\\u2031" and the multiplier to be 1000.
*
* @return the multiplier for use in percent, permill, etc.
* Examples: with 100, 1.23 -> "123", and "123" -> 1.23
@ -1058,7 +1058,7 @@ public:
* Set the multiplier for use in percent, permill, etc.
* For a percentage, set the suffixes to have "%" and the multiplier to be 100.
* (For Arabic, use arabic percent symbol).
* For a permill, set the suffixes to have "\u2031" and the multiplier to be 1000.
* For a permill, set the suffixes to have "\\u2031" and the multiplier to be 1000.
*
* @param newValue the new value of the multiplier for use in percent, permill, etc.
* Examples: with 100, 1.23 -> "123", and "123" -> 1.23
@ -1859,6 +1859,7 @@ protected:
* this number, it wouldn't make sense anyway, and this is just to make sure
* that someone turning on scientific mode with default settings doesn't
* end up with lots of zeroes.
* @draft ICU 2.8
*/
static const int32_t kMaxScientificIntegerDigits;
};

3
icu4c/source/i18n/unicode/format.h
View file

@ -247,9 +247,10 @@ public:
const char* getLocaleID(ULocDataLocaleType type, UErrorCode &status) const;
protected:
/** @draft ICU 2.8 */
void setLocales(const ResourceBundle& res);
/** @draft ICU 2.8 */
void setLocaleIDs(const char* valid, const char* actual);
protected:

1
icu4c/source/i18n/unicode/gregocal.h
View file

@ -619,6 +619,7 @@ protected:
* where YEAR, EXTENDED_YEAR are not set.
* The Gregorian implementation assumes a yearWoy in gregorian format, according to the current era.
* @return the extended year, UCAL_EXTENDED_YEAR
* @internal
*/
virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy);

7
icu4c/source/i18n/unicode/numfmt.h
View file

@ -34,6 +34,9 @@ U_NAMESPACE_BEGIN
class NumberFormatFactory;
class StringEnumeration;
/**
* @internal
*/
typedef const void* URegistryKey;
/**
@ -756,7 +759,7 @@ private:
* supports. When registered, the locales it supports extend or override the
* locale already supported by ICU.
*
* @prototype
* @draft ICU 2.6
*/
class U_I18N_API NumberFormatFactory : public UObject {
public:
@ -794,7 +797,7 @@ public:
/**
* A NumberFormatFactory that supports a single locale. It can be visible or invisible.
* @prototype
* @draft ICU 3.0
*/
class U_I18N_API SimpleNumberFormatFactory : public NumberFormatFactory {
protected:

13
icu4c/source/i18n/unicode/rbnf.h
View file

@ -10,6 +10,13 @@
#include "unicode/utypes.h"
/**
* \def U_HAVE_RBNF
* This will be 0 if RBNF support is not included in ICU
* and 1 if it is.
*
* @stable ICU 2.4
*/
#if defined(U_INT64_T_UNAVAILABLE) || UCONFIG_NO_FORMATTING
#define U_HAVE_RBNF 0
#else
@ -26,7 +33,11 @@ U_NAMESPACE_BEGIN
class NFRuleSet;
/** Tags for the predefined rulesets. */
/**
* Tags for the predefined rulesets.
*
* @stable ICU 2.2
*/
enum URBNFRuleSetTag {
URBNF_SPELLOUT,
URBNF_ORDINAL,

2
icu4c/source/i18n/unicode/regex.h
View file

@ -28,7 +28,7 @@
* <code>RegexPattern</code> and <code>RegexMatcher</code>.
* <code>RegexPattern</code> objects represent a pre-processed, or compiled
* regular expression. They are created from a regular expression pattern string,
* and can be used to create <RegexMatcher> objects for the pattern.</p>
* and can be used to create <code>RegexMatcher</code> objects for the pattern.</p>
*
* <p>Class <code>RegexMatcher</code> bundles together a regular expression
* pattern and a target string to which the search pattern will be applied.

4
icu4c/source/i18n/unicode/translit.h
View file

@ -865,8 +865,8 @@ public:
* @param result the string to receive the rules. Previous
* contents will be deleted.
* @param escapeUnprintable if TRUE then convert unprintable
* character to their hex escape representations, \uxxxx or
* \Uxxxxxxxx. Unprintable characters are those other than
* character to their hex escape representations, \\uxxxx or
* \\Uxxxxxxxx. Unprintable characters are those other than
* U+000A, U+0020..U+007E.
* @stable ICU 2.0
*/

4
icu4c/source/i18n/unicode/ucal.h
View file

@ -618,7 +618,7 @@ ucal_getAvailable(int32_t index);
/**
* Determine how many locales have calendars available.
* This function is most useful as determining the loop ending condition for
* calls to \Ref{ucal_getAvailable}.
* calls to \ref ucal_getAvailable.
* @return The number of locales for which calendars are available.
* @see ucal_getAvailable
* @stable ICU 2.0
@ -912,7 +912,7 @@ ucal_getAvailableTZIDs(int32_t rawOffset,
/**
* Determine how many TimeZones exist with a certain offset.
* This function is most useful as determining the loop ending condition for
* calls to \Ref{ucal_getAvailableTZIDs}.
* calls to \ref ucal_getAvailableTZIDs.
* @param rawOffset The desired GMT offset.
* @return The number of TimeZones with rawOffset.
* @see ucal_getAvailableTZIDs

3
icu4c/source/i18n/unicode/ucurr.h
View file

@ -11,6 +11,9 @@
#if !UCONFIG_NO_FORMATTING
/**
* @internal
*/
typedef const void* UCurrRegistryKey;
/**

8
icu4c/source/i18n/unicode/utrans.h
View file

@ -76,16 +76,16 @@ typedef void* UTransliterator;
typedef enum UTransDirection {
/**
* UTRANS_FORWARD means from <source> to <target> for a
* transliterator with ID <source>-<target>. For a transliterator
* UTRANS_FORWARD means from &lt;source&gt; to &lt;target&gt; for a
* transliterator with ID &lt;source&gt;-&lt;target&gt;. For a transliterator
* opened using a rule, it means forward direction rules, e.g.,
* "A > B".
*/
UTRANS_FORWARD,
/**
* UTRANS_REVERSE means from <target> to <source> for a
* transliterator with ID <source>-<target>. For a transliterator
* UTRANS_REVERSE means from &lt;target&gt; to &lt;source&gt; for a
* transliterator with ID &lt;source&gt;-&lt;target&gt;. For a transliterator
* opened using a rule, it means reverse direction rules, e.g.,
* "A < B".
*/