AuroraMiddleware/scuffed-code
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ICU-7353 docs fixup and updated API Change Report

Browse Source 
X-SVN-Rev: 27537
This commit is contained in:
Steven R. Loomis 2010-02-11 00:53:57 +00:00
parent 34c4f9f0f3
commit 1457da183c
17 changed files with 218 additions and 190 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

284
icu4c/APIChangeReport.html
View File

File diff suppressed because it is too large Load Diff

6
icu4c/source/common/unicode/brkiter.h
View File

@ -1,6 +1,6 @@
/*
********************************************************************************
* Copyright (C) 1997-2007, International Business Machines
* Copyright (C) 1997-2010, International Business Machines
* Corporation and others. All Rights Reserved.
********************************************************************************
*
@ -91,10 +91,10 @@ U_NAMESPACE_BEGIN
* plain C API with equivalent functionality is defined in the
* file ubrk.h
* <p>
* Code snippits illustrating the use of the Break Iterator APIs
* Code snippets illustrating the use of the Break Iterator APIs
* are available in the ICU User Guide,
* http://icu-project.org/userguide/boundaryAnalysis.html
* and in the sample program icu/source/samples/break/break.cpp"
* and in the sample program icu/source/samples/break/break.cpp
*
*/
class U_COMMON_API BreakIterator : public UObject {

2
icu4c/source/common/unicode/bytestream.h
View File

@ -214,7 +214,7 @@ class StringByteSink : public ByteSink {
StringByteSink(StringClass* dest) : dest_(dest) { }
/**
* Append "bytes[0,n-1]" to this.
* @param bytes the pointer to the bytes
* @param data the pointer to the bytes
* @param n the number of bytes; must be non-negative
* @stable ICU 4.2
*/

16
icu4c/source/common/unicode/platform.h.in
View File

@ -83,7 +83,7 @@
/**
* \def U_HAVE_STD_STRING
* Define whether the standard C++ (STL) <string> header is available.
* Define whether the standard C++ (STL) &lt;string&gt; header is available.
* For platforms that do not use platform.h and do not define this constant
* in their platform-specific headers, std_string.h defaults
* U_HAVE_STD_STRING to 1.
@ -372,9 +372,21 @@
/*===========================================================================*/
/* Custom icu entry point renaming */
/*===========================================================================*/
/* Define the library suffix in a C syntax. */
/**
* Define the library suffix with C syntax.
* @internal
*/
# define U_LIB_SUFFIX_C_NAME @ICULIBSUFFIXCNAME@
/**
* Define the library suffix as a string with C syntax
* @internal
*/
# define U_LIB_SUFFIX_C_NAME_STRING "@ICULIBSUFFIXCNAME@"
/**
* 1 if a custom library suffix is set
* @internal
*/
# define U_HAVE_LIB_SUFFIX @U_HAVE_LIB_SUFFIX@
#if U_HAVE_LIB_SUFFIX

6
icu4c/source/common/unicode/std_string.h
View File

@ -1,7 +1,7 @@
/*
*******************************************************************************
*
* Copyright (C) 2009, International Business Machines
* Copyright (C) 2009-2010, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
@ -19,7 +19,7 @@
/**
* \file
* \brief C++ API: Central ICU header for including the C++ standard <string>
* \brief C++ API: Central ICU header for including the C++ standard &lt;string&gt;
* header and for related definitions.
*/
@ -27,7 +27,7 @@
/**
* \def U_HAVE_STD_STRING
* Define whether the standard C++ (STL) <string> header is available.
* Define whether the standard C++ (STL) &lt;string&gt; header is available.
* @draft ICU 4.2
*/
#ifndef U_HAVE_STD_STRING

4
icu4c/source/common/unicode/uidna.h
View File

@ -76,7 +76,7 @@
* This function implements the ToASCII operation as defined in the IDNA RFC.
* This operation is done on <b>single labels</b> before sending it to something that expects
* ASCII names. A label is an individual part of a domain name. Labels are usually
* separated by dots; e.g." "www.example.com" is composed of 3 labels "www","example", and "com".
* separated by dots; e.g. "www.example.com" is composed of 3 labels "www","example", and "com".
*
*
* @param src Input UChar array containing label in Unicode.
@ -122,7 +122,7 @@ uidna_toASCII(const UChar* src, int32_t srcLength,
* This function implements the ToUnicode operation as defined in the IDNA RFC.
* This operation is done on <b>single labels</b> before sending it to something that expects
* Unicode names. A label is an individual part of a domain name. Labels are usually
* separated by dots; for e.g." "www.example.com" is composed of 3 labels "www","example", and "com".
* separated by dots; for e.g. "www.example.com" is composed of 3 labels "www","example", and "com".
*
* @param src Input UChar array containing ASCII (ACE encoded) label.
* @param srcLength Number of UChars in src, or -1 if NUL-terminated.

2
icu4c/source/common/unicode/unistr.h
View File

@ -3082,7 +3082,7 @@ public:
*
* \\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
* \\&quot; => U+0022, \\' => U+0027, \\? => U+003F, \\\\ => U+005C
*
* Anything else following a backslash is generically escaped. For
* example, "[a\\-z]" returns "[a-z]".

2
icu4c/source/common/unicode/ustring.h
View File

@ -967,7 +967,7 @@ u_memrchr32(const UChar *s, UChar32 c, int32_t count);
*
* \\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
* \\&quot; => U+0022, \\' => U+0027, \\? => U+003F, \\\\ => U+005C
*
* Anything else following a backslash is generically escaped. For
* example, "[a\\-z]" returns "[a-z]".

2
icu4c/source/i18n/unicode/decimfmt.h
View File

@ -126,7 +126,7 @@ class FieldPositionHandler;
* str.remove();
* cout << "format result " << form->format(myNumber, str) << endl;
* format->parse(form->format(myNumber, str), fmtable, success);
* }</pre></blockquote>
* }</pre>
*
*
* <p><strong>Patterns</strong>

2
icu4c/source/i18n/unicode/dtfmtsym.h
View File

@ -214,7 +214,7 @@ public:
void setEraNames(const UnicodeString* eraNames, int32_t count);
/**
* Gets narrow era strings. For example: A" and "D".
* Gets narrow era strings. For example: "A" and "B".
*
* @param count Filled in with length of the array.
* @return the narrow era strings.

18
icu4c/source/i18n/unicode/dtitvfmt.h
View File

@ -1,5 +1,5 @@
/********************************************************************************
* Copyright (C) 2008-2009, International Business Machines Corporation and others. All Rights Reserved.
* Copyright (C) 2008-2010, International Business Machines Corporation and others. All Rights Reserved.
*******************************************************************************
*
* File DTITVFMT.H
@ -112,15 +112,15 @@ U_NAMESPACE_BEGIN
* There is a set of pre-defined static skeleton strings.
* There are pre-defined interval patterns for those pre-defined skeletons
* in locales' resource files.
* For example, for a skeleton UDAT_YEAR_ABBR_MONTH_DAY, which is "yMMMd",
* For example, for a skeleton UDAT_YEAR_ABBR_MONTH_DAY, which is &quot;yMMMd&quot;,
* in en_US, if the largest different calendar field between date1 and date2
* is "year", the date interval pattern is "MMM d, yyyy - MMM d, yyyy",
* such as "Jan 10, 2007 - Jan 10, 2008".
* If the largest different calendar field between date1 and date2 is "month",
* the date interval pattern is "MMM d - MMM d, yyyy",
* such as "Jan 10 - Feb 10, 2007".
* If the largest different calendar field between date1 and date2 is "day",
* the date interval pattern is ""MMM d-d, yyyy", such as "Jan 10-20, 2007".
* is &quot;year&quot;, the date interval pattern is &quot;MMM d, yyyy - MMM d, yyyy&quot;,
* such as &quot;Jan 10, 2007 - Jan 10, 2008&quot;.
* If the largest different calendar field between date1 and date2 is &quot;month&quot;,
* the date interval pattern is &quot;MMM d - MMM d, yyyy&quot;,
* such as &quot;Jan 10 - Feb 10, 2007&quot;.
* If the largest different calendar field between date1 and date2 is &quot;day&quot;,
* the date interval pattern is &quot;MMM d-d, yyyy&quot;, such as &quot;Jan 10-20, 2007&quot;.
*
* For date skeleton, the interval patterns when year, or month, or date is
* different are defined in resource files.

36
icu4c/source/i18n/unicode/dtitvinf.h
View File

@ -86,22 +86,22 @@ U_NAMESPACE_BEGIN
* The largest different calendar fields between 2 calendars is the
* first different calendar field in above order.
*
* For example: the largest different calendar fields between "Jan 10, 2007"
* and "Feb 20, 2008" is year.
* For example: the largest different calendar fields between &quot;Jan 10, 2007&quot;
* and &quot;Feb 20, 2008&quot; is year.
*
* <P>
* There is a set of pre-defined static skeleton strings.
* There are pre-defined interval patterns for those pre-defined skeletons
* in locales' resource files.
* For example, for a skeleton UDAT_YEAR_ABBR_MONTH_DAY, which is "yMMMd",
* For example, for a skeleton UDAT_YEAR_ABBR_MONTH_DAY, which is &quot;yMMMd&quot;,
* in en_US, if the largest different calendar field between date1 and date2
* is "year", the date interval pattern is "MMM d, yyyy - MMM d, yyyy",
* such as "Jan 10, 2007 - Jan 10, 2008".
* If the largest different calendar field between date1 and date2 is "month",
* the date interval pattern is "MMM d - MMM d, yyyy",
* such as "Jan 10 - Feb 10, 2007".
* If the largest different calendar field between date1 and date2 is "day",
* the date interval pattern is ""MMM d-d, yyyy", such as "Jan 10-20, 2007".
* is &quot;year&quot;, the date interval pattern is &quot;MMM d, yyyy - MMM d, yyyy&quot;,
* such as &quot;Jan 10, 2007 - Jan 10, 2008&quot;.
* If the largest different calendar field between date1 and date2 is &quot;month&quot;,
* the date interval pattern is &quot;MMM d - MMM d, yyyy&quot;,
* such as &quot;Jan 10 - Feb 10, 2007&quot;.
* If the largest different calendar field between date1 and date2 is &quot;day&quot;,
* the date interval pattern is &quot;MMM d-d, yyyy&quot;, such as &quot;Jan 10-20, 2007&quot;.
*
* For date skeleton, the interval patterns when year, or month, or date is
* different are defined in resource files.
@ -114,17 +114,17 @@ U_NAMESPACE_BEGIN
* in an interval pattern is the earlier date. There might be a locale in which
* the first date in an interval pattern is the later date.
* We use fallback format for the default order for the locale.
* For example, if the fallback format is "{0} - {1}", it means
* For example, if the fallback format is &quot;{0} - {1}&quot;, it means
* the first date in the interval pattern for this locale is earlier date.
* If the fallback format is "{1} - {0}", it means the first date is the
* If the fallback format is &quot;{1} - {0}&quot;, it means the first date is the
* later date.
* For a particular interval pattern, the default order can be overriden
* by prefixing "latestFirst:" or "earliestFirst:" to the interval pattern.
* For example, if the fallback format is "{0}-{1}",
* but for skeleton "yMMMd", the interval pattern when day is different is
* "latestFirst:d-d MMM yy", it means by default, the first date in interval
* pattern is the earlier date. But for skeleton "yMMMd", when day is different,
* the first date in "d-d MMM yy" is the later date.
* by prefixing &quot;latestFirst:&quot; or &quot;earliestFirst:&quot; to the interval pattern.
* For example, if the fallback format is &quot;{0}-{1}&quot;,
* but for skeleton &quot;yMMMd&quot;, the interval pattern when day is different is
* &quot;latestFirst:d-d MMM yy&quot;, it means by default, the first date in interval
* pattern is the earlier date. But for skeleton &quot;yMMMd&quot;, when day is different,
* the first date in &quot;d-d MMM yy&quot; is the later date.
*
* <P>
* The recommended way to create a DateIntervalFormat object is to pass in

16
icu4c/source/i18n/unicode/plurfmt.h
View File

@ -1,6 +1,6 @@
/*
*******************************************************************************
* Copyright (C) 2007-2009, International Business Machines Corporation and
* Copyright (C) 2007-2010, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*
@ -97,7 +97,7 @@ class Hashtable;
* message text of the plural case "<code>other</code>" gets assigned to this
* plural case. If you specify more than one message for the same plural case,
* U_DUPLICATE_KEYWORD will be set to status.
* <br/>
* <br>
* Spaces between <code><i>caseKeyword</i></code> and
* <code><i>message</i></code> will be ignored; spaces within
* <code><i>message</i></code> will be preserved.
@ -107,9 +107,9 @@ class Hashtable;
* can use the strings produced by <code>PluralFormat</code> with other
* formatters. If you are using <code>PluralFormat</code> inside a
* <code>MessageFormat</code> pattern, <code>MessageFormat</code> will
* automatically evaluate the resulting format pattern.<br/>
* automatically evaluate the resulting format pattern.<br>
* Thus, curly braces (<code>{</code>, <code>}</code>) are <i>only</i> allowed
* in message texts to define a nested format pattern.<br/>
* in message texts to define a nested format pattern.<br>
* The pound sign (<code>#</code>) will be interpreted as the number placeholder
* in the message text, if it is not contained in curly braces (to preserve
* <code>NumberFormat</code> patterns). <code>PluralFormat</code> will
@ -138,11 +138,11 @@ class Hashtable;
* msgFmt->format(args2, 1, result, ignore, status);
* cout << result << endl;
* </pre>
* Produces the output:<br/>
* <code>C'est 0,0 fichier dans la liste.</code><br/>
* Produces the output:<br>
* <code>C'est 0,0 fichier dans la liste.</code><br>
* <code>Ce sont 3 fichiers dans la liste."</code>
* <p>
* <strong>Note:</strong><br/>
* <strong>Note:</strong><br>
* Currently <code>PluralFormat</code>
* does not make use of quotes like <code>MessageFormat</code>.
* If you use plural format strings with <code>MessageFormat</code> and want
@ -361,7 +361,7 @@ public:
*
* @param number a number for which the plural message should be formatted
* for. If no pattern has been applied to this
* <code>PluralFormat</code> object yet, the formatted number
* PluralFormat object yet, the formatted number
* will be returned.
* @param appendTo output parameter to receive result.
* result is appended to existing contents.

4
icu4c/source/i18n/unicode/selfmt.h
View File

@ -139,7 +139,7 @@ class Hashtable;
* it's provided to returns the error <code>U_DEFAULT_KEYWORD_MISSING</code>.
* If a pattern provides more than one phrase for the same keyword, the
* error <code>U_DUPLICATE_KEYWORD</code> is returned.
* <br/>
* <br>
* Spaces between <code><i>keyword</i></code> and
* <code>{<i>phrase</i>}</code> will be ignored; spaces within
* <code>{<i>phrase</i>}</code> will be preserved.<p>
@ -173,7 +173,7 @@ class Hashtable;
* \endhtmlonly
* </p>
*
* Produces the output:<br/>
* Produces the output:<br>
* \htmlonly
* <code>Kirti est all&#x00E9;e &#x00E0; Paris.</code>
* \endhtmlonly

5
icu4c/source/i18n/unicode/uregex.h
View File

@ -1007,7 +1007,6 @@ uregex_appendTail(URegularExpression *regexp,
* obtain the input string and with the position
* of the last match within it.
* @param dest A mutable UText that will receive the result. Must not be NULL.
* @param status A reference to a UErrorCode to receive any errors.
* @return The destination UText.
*
* @internal ICU 4.4 technology preview
@ -1092,10 +1091,10 @@ uregex_split( URegularExpression *regexp,
* instead, it is based on (and implemented directly on top of) the C++ split method.
*
* @param regexp The compiled regular expression.
* @param dest An array of mutable UText structs to receive the results of the split.
* @param destFields An array of mutable UText structs to receive the results of the split.
* If a field is NULL, a new UText is allocated to contain the results for
* that field. This new UText is not guaranteed to be mutable.
* @param destCapacity The number of elements in the destination array.
* @param destFieldsCapacity The number of elements in the destination array.
* If the number of fields found is less than destCapacity, the
* extra strings in the destination array are not altered.
* If the number of destination strings is less than the number

2
icu4c/source/io/unicode/ustdio.h
View File

@ -413,7 +413,7 @@ u_fgetcodepage(UFILE *file);
* mix codepages within a file. This should only be called right
* after opening the <TT>UFile</TT>, or after calling <TT>u_frewind</TT>.
* @param codepage The codepage in which data will be written to
* and read from the file. For example <TT>"latin-1"</TT> or <TT>"ibm-943</TT>.
* and read from the file. For example <TT>"latin-1"</TT> or <TT>"ibm-943"</TT>.
* A value of NULL means the default codepage for the UFILE's current
* locale will be used.
* @param file The UFILE to set.

1
icu4c/source/layout/LEGlyphStorage.h
View File

@ -342,7 +342,6 @@ public:
*
* @param atIndex the index of the glyph to be replaced
* @param insertCount the number of glyphs to replace it with
* @param success set to an error code if the auxillary data cannot be retrieved.
*
* @return the address at which to store the replacement glyphs.
*