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: 15882
This commit is contained in:
Eric Mader 2004-06-15 22:32:41 +00:00
parent 60d2cebe21
commit 6c34ce45ed
9 changed files with 57 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
icu4c/source/common/unicode/locid.h
View file

@ -55,13 +55,13 @@
* <P>
* You create a <code>Locale</code> object using the constructor in
* this class:
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* . Locale( const char* language,
* . const char* country,
* . const char* variant);
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* The first argument to the constructors is a valid <STRONG>ISO
* Language Code.</STRONG> These codes are the lower-case two-letter
* codes as defined by ISO-639.
@ -103,11 +103,11 @@
* that you can use to create <code>Locale</code> objects for commonly used
* locales. For example, the following refers to a <code>Locale</code> object
* for the United States:
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* Locale::getUS()
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* <P>
* Once you've created a <code>Locale</code> you can query it for information about
@ -130,7 +130,7 @@
* for creating a default object of that type. For example, the
* <code>NumberFormat</code> class provides these three convenience methods
* for creating a default <code>NumberFormat</code> object:
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* UErrorCode success = U_ZERO_ERROR;
* Locale myLocale;
@ -140,16 +140,16 @@
* nf = NumberFormat::createCurrencyInstance( success ); delete nf;
* nf = NumberFormat::createPercentInstance( success ); delete nf;
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* Each of these methods has two variants; one with an explicit locale
* and one without; the latter using the default locale.
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* nf = NumberFormat::createInstance( myLocale, success ); delete nf;
* nf = NumberFormat::createCurrencyInstance( myLocale, success ); delete nf;
* nf = NumberFormat::createPercentInstance( myLocale, success ); delete nf;
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* A <code>Locale</code> is the mechanism for identifying the kind of object
* (<code>NumberFormat</code>) that you would like to get. The locale is
* <STRONG>just</STRONG> a mechanism for identifying objects,
@ -163,7 +163,7 @@
* For example, you can create a menu of all the collation objects
* suitable for a given language. Such classes implement these
* three class methods:
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* static Locale* getAvailableLocales(int32_t& numLocales)
* static UnicodeString& getDisplayName(const Locale& objectLocale,
@ -172,7 +172,7 @@
* static UnicodeString& getDisplayName(const Locale& objectLocale,
* UnicodeString& displayName)
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* @stable ICU 2.0
* @see ResourceBundle

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

@ -40,7 +40,7 @@
* <P>
* You create a <code>Locale</code> with one of the three options listed below.
* Each of the component is separated by '_' in the locale string.
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* newLanguage
@ -50,7 +50,7 @@
* newLanguage + newCountry + newVariant
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* The first option is a valid <STRONG>ISO
* Language Code.</STRONG> These codes are the lower-case two-letter
* codes as defined by ISO-639.
@ -93,13 +93,13 @@
* that you can use to specify the commonly used
* locales. For example, the following refers to a locale
* for the United States:
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* ULOC_US
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* <P>
* Once you've specified a locale you can query it for information about
@ -119,7 +119,7 @@
* operations. For example, the <code>unum_xxx</code> functions format
* numbers, currency, or percentages in a locale-sensitive manner.
* </P>
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* UErrorCode success = U_ZERO_ERROR;
@ -134,10 +134,10 @@
* unum_close(nf);
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* Each of these methods has two variants; one with an explicit locale
* and one without; the latter using the default locale.
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
*
@ -149,7 +149,7 @@
* unum_close(nf);
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* A <code>Locale</code> is the mechanism for identifying the kind of services
* (<code>UNumberFormat</code>) that you would like to get. The locale is
* <STRONG>just</STRONG> a mechanism for identifying these services.
@ -163,7 +163,7 @@
* For example, you can create a menu of all the collation objects
* suitable for a given language. Such classes implement these
* three class methods:
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* const char* uloc_getAvailable(int32_t index);
@ -177,7 +177,7 @@
*
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* <P>
* Concerning POSIX/RFC1766 Locale IDs,
* the getLanguage/getCountry/getVariant/getName functions do understand

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

@ -68,7 +68,7 @@ class RuleCharacterIterator;
* similar to that employed by version 8 regular expression character
* classes. Here are some simple examples:
*
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <table>
* <tr align="top">
* <td nowrap valign="top" align="left"><code>[]</code></td>
@ -99,7 +99,7 @@ class RuleCharacterIterator;
* <td valign="top">All characters in the general category Uppercase Letter</td>
* </tr>
* </table>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* Any character may be preceded by a backslash in order to remove any special
* meaning. White space characters, as defined by UCharacter.isWhitespace(), are
@ -168,7 +168,7 @@ class RuleCharacterIterator;
*
* <p><b>Formal syntax</b></p>
*
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <table>
* <tr align="top">
* <td nowrap valign="top" align="right"><code>pattern :=&nbsp; </code></td>
@ -250,7 +250,7 @@ class RuleCharacterIterator;
* </td>
* </tr>
* </table>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* @author Alan Liu
* @stable ICU 2.0

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

@ -73,11 +73,11 @@ typedef int32_t UFieldResolutionTable[12][8];
* object of this type. <code>Calendar</code>'s <code>createInstance</code> method
* returns the appropriate <code>Calendar</code> subclass whose
* time fields have been initialized with the current date and time:
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* Calendar *rightNow = Calendar::createInstance(errCode);
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* <p>
* A <code>Calendar</code> object can produce all the time field values
@ -104,7 +104,7 @@ typedef int32_t UFieldResolutionTable[12][8];
* combinations of fields. The most recent combination, as determined by the
* most recently set single field, will be used.
*
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* MONTH + DAY_OF_MONTH
* MONTH + WEEK_OF_MONTH + DAY_OF_WEEK
@ -112,16 +112,16 @@ typedef int32_t UFieldResolutionTable[12][8];
* DAY_OF_YEAR
* DAY_OF_WEEK + WEEK_OF_YEAR
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* For the time of day:
*
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* HOUR_OF_DAY
* AM_PM + HOUR
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* <p>
* <strong>Note:</strong> for some non-Gregorian calendars, different

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

@ -131,9 +131,9 @@ class MessageFormat;
* <code>X</code> and and index value <code>j</code> in the range
* <code>0..n-1</code>, where <code>n</code> is the number of ranges:</p>
*
* <blockquote><code>X</code> matches <code>j</code> if and only if
* \htmlonly<blockquote>\endhtmlonly<code>X</code> matches <code>j</code> if and only if
* <code>limit[j] &lt;= X &lt; limit[j+1]</code>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* <p>(This assumes that all closures are <code>FALSE</code>. If some
* closures are <code>TRUE</code> then the relations must be changed to

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

@ -99,7 +99,7 @@ class CollationKey;
* <p>
* The following example shows how to compare two strings using the
* <code>Collator</code> for the default locale.
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* // Compare two strings in the default locale
@ -111,7 +111,7 @@ class CollationKey;
* cout << "abc is greater than or equal to ABC" << endl;
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* <p>
* You can set a <code>Collator</code>'s <em>strength</em> property to
* determine the level of difference considered significant in comparisons.
@ -122,7 +122,7 @@ class CollationKey;
* secondary differences, "e" and "E" are tertiary differences and "e" and "e"
* are identical. The following shows how both case and accents could be
* ignored for US English.
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* //Get the Collator for US English and set its strength to PRIMARY
@ -136,7 +136,7 @@ class CollationKey;
* endl;
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* <p>
* For comparing strings exactly once, the <code>compare</code> method
* provides the best performance. When sorting a list of strings however, it

10
icu4c/source/i18n/unicode/timezone.h
View file

@ -53,11 +53,11 @@ class StringEnumeration;
* with a time zone ID. For instance, the time zone ID for the Pacific
* Standard Time zone is "PST". So, you can get a PST <code>TimeZone</code> object
* with:
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* TimeZone *tz = TimeZone::createTimeZone("PST");
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
* You can use <code>getAvailableIDs</code> method to iterate through
* all the supported time zone IDs. You can then choose a
* supported ID to get a <code>TimeZone</code>.
@ -65,11 +65,11 @@ class StringEnumeration;
* supported IDs, then you can create a custom time zone ID with
* the following syntax:
*
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* GMT[+|-]hh[[:]mm]
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* For example, you might specify GMT+14:00 as a custom
* time zone ID. The <code>TimeZone</code> that is returned
@ -450,7 +450,7 @@ public:
* blockquote><pre>
* . TimeZone* foo = TimeZone::createTimeZone("America/New_York");
* . foo.setID("America/Los_Angeles");
* </pre></blockquote>
* </pre>\htmlonly</blockquote>\endhtmlonly
* the time zone's GMT offset and daylight-savings rules don't change to those for
* Los Angeles. They're still those for New York. Only the ID has changed.)
*

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

@ -69,8 +69,8 @@ class TransliteratorIDParser;
* transliteration. For example, given a string <code>input</code>
* and a transliterator <code>t</code>, the call
*
* <blockquote><code>String result = t.transliterate(input);
* </code></blockquote>
* \htmlonly<blockquote>\endhtmlonly<code>String result = t.transliterate(input);
* </code>\htmlonly</blockquote>\endhtmlonly
*
* will transliterate it and return the result. Other methods allow
* the client to specify a substring to be transliterated and to use
@ -92,20 +92,20 @@ class TransliteratorIDParser;
*
* <p>Consider the simple <code>RuleBasedTransliterator</code>:
*
* <blockquote><code>
* \htmlonly<blockquote>\endhtmlonly<code>
* th&gt;{theta}<br>
* t&gt;{tau}
* </code></blockquote>
* </code>\htmlonly</blockquote>\endhtmlonly
*
* When the user types 't', nothing will happen, since the
* transliterator is waiting to see if the next character is 'h'. To
* remedy this, we introduce the notion of a cursor, marked by a '|'
* in the output string:
*
* <blockquote><code>
* \htmlonly<blockquote>\endhtmlonly<code>
* t&gt;|{tau}<br>
* {tau}h&gt;{theta}
* </code></blockquote>
* </code>\htmlonly</blockquote>\endhtmlonly
*
* Now when the user types 't', tau appears, and if the next character
* is 'h', the tau changes to a theta. This is accomplished by
@ -164,13 +164,13 @@ class TransliteratorIDParser;
* to 'B', and <b>BA</b>, which transliterates 'B' to 'A'. It might
* seem that these are exact inverses, since
*
* <blockquote>"A" x <b>AB</b> -> "B"<br>
* "B" x <b>BA</b> -> "A"</blockquote>
* \htmlonly<blockquote>\endhtmlonly"A" x <b>AB</b> -> "B"<br>
* "B" x <b>BA</b> -> "A"\htmlonly</blockquote>\endhtmlonly
*
* where 'x' represents transliteration. However,
*
* <blockquote>"ABCD" x <b>AB</b> -> "BBCD"<br>
* "BBCD" x <b>BA</b> -> "AACD"</blockquote>
* \htmlonly<blockquote>\endhtmlonly"ABCD" x <b>AB</b> -> "BBCD"<br>
* "BBCD" x <b>BA</b> -> "AACD"\htmlonly</blockquote>\endhtmlonly
*
* so <b>AB</b> composed with <b>BA</b> is not the
* identity. Nonetheless, <b>BA</b> may be usefully considered to be

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

@ -36,7 +36,7 @@
* <code>UCalendar</code> whose time fields have been initialized
* with the current date and time. We need to specify the type of
* calendar to be opened and the timezoneId.
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* UCalendar *caldef;
@ -47,7 +47,7 @@
* caldef=ucal_open(tzID, u_strlen(tzID), NULL, UCAL_TRADITIONAL, &status);
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* <p>
* A <code>UCalendar</code> object can produce all the time field values
@ -74,7 +74,7 @@
* combinations of fields. The most recent combination, as determined by the
* most recently set single field, will be used.
*
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* UCAL_MONTH + UCAL_DAY_OF_MONTH
@ -84,18 +84,18 @@
* UCAL_DAY_OF_WEEK + UCAL_WEEK_OF_YEAR
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* For the time of day:
*
* <blockquote>
* \htmlonly<blockquote>\endhtmlonly
* <pre>
* \code
* UCAL_HOUR_OF_DAY
* UCAL_AM_PM + UCAL_HOUR
* \endcode
* </pre>
* </blockquote>
* \htmlonly</blockquote>\endhtmlonly
*
* <p>
* <strong>Note:</strong> for some non-Gregorian calendars, different