From 6c34ce45edf092cc631c293589fb971ba0d8a5de Mon Sep 17 00:00:00 2001 From: Eric Mader Date: Tue, 15 Jun 2004 22:32:41 +0000 Subject: [PATCH] ICU-3820 fix doxygen warnings. X-SVN-Rev: 15882 --- icu4c/source/common/unicode/locid.h | 20 ++++++++++---------- icu4c/source/common/unicode/uloc.h | 20 ++++++++++---------- icu4c/source/common/unicode/uniset.h | 8 ++++---- icu4c/source/i18n/unicode/calendar.h | 12 ++++++------ icu4c/source/i18n/unicode/choicfmt.h | 4 ++-- icu4c/source/i18n/unicode/coll.h | 8 ++++---- icu4c/source/i18n/unicode/timezone.h | 10 +++++----- icu4c/source/i18n/unicode/translit.h | 20 ++++++++++---------- icu4c/source/i18n/unicode/ucal.h | 12 ++++++------ 9 files changed, 57 insertions(+), 57 deletions(-) diff --git a/icu4c/source/common/unicode/locid.h b/icu4c/source/common/unicode/locid.h index aa05028963a..b9552bbcb29 100644 --- a/icu4c/source/common/unicode/locid.h +++ b/icu4c/source/common/unicode/locid.h @@ -55,13 +55,13 @@ *

* You create a Locale object using the constructor in * this class: - *

+ * \htmlonly
\endhtmlonly * 
  * .      Locale( const   char*  language, 
  * .              const   char*  country, 
  * .              const   char*  variant);
  *
- *
+ * \htmlonly
\endhtmlonly * The first argument to the constructors is a valid ISO * Language Code. These codes are the lower-case two-letter * codes as defined by ISO-639. @@ -103,11 +103,11 @@ * that you can use to create Locale objects for commonly used * locales. For example, the following refers to a Locale object * for the United States: - *
+ * \htmlonly
\endhtmlonly * 
  *       Locale::getUS()
  *
- *
+ * \htmlonly
\endhtmlonly * *

* Once you've created a Locale you can query it for information about @@ -130,7 +130,7 @@ * for creating a default object of that type. For example, the * NumberFormat class provides these three convenience methods * for creating a default NumberFormat object: - *

+ * \htmlonly
\endhtmlonly * 
  *     UErrorCode success = U_ZERO_ERROR;
  *     Locale myLocale;
@@ -140,16 +140,16 @@
  *     nf = NumberFormat::createCurrencyInstance( success );  delete nf;
  *     nf = NumberFormat::createPercentInstance( success );   delete nf;
  *
- *
+ * \htmlonly
\endhtmlonly * Each of these methods has two variants; one with an explicit locale * and one without; the latter using the default locale. - *
+ * \htmlonly
\endhtmlonly * 
  *     nf = NumberFormat::createInstance( myLocale, success );          delete nf;
  *     nf = NumberFormat::createCurrencyInstance( myLocale, success );  delete nf;
  *     nf = NumberFormat::createPercentInstance( myLocale, success );   delete nf;
  *
- *
+ * \htmlonly
\endhtmlonly * A Locale is the mechanism for identifying the kind of object * (NumberFormat) that you would like to get. The locale is * just 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: - *
+ * \htmlonly
\endhtmlonly * 
  *       static Locale* getAvailableLocales(int32_t& numLocales)
  *       static UnicodeString& getDisplayName(const Locale&  objectLocale,
@@ -172,7 +172,7 @@
  *       static UnicodeString& getDisplayName(const Locale&  objectLocale,
  *                                            UnicodeString& displayName)
  *
- *
+ * \htmlonly
\endhtmlonly * * @stable ICU 2.0 * @see ResourceBundle diff --git a/icu4c/source/common/unicode/uloc.h b/icu4c/source/common/unicode/uloc.h index a186ce5e306..7902ae0adc3 100644 --- a/icu4c/source/common/unicode/uloc.h +++ b/icu4c/source/common/unicode/uloc.h @@ -40,7 +40,7 @@ *

* You create a Locale with one of the three options listed below. * Each of the component is separated by '_' in the locale string. - *

+ * \htmlonly
\endhtmlonly * 
  * \code
  *       newLanguage
@@ -50,7 +50,7 @@
  *       newLanguage + newCountry + newVariant
  * \endcode
  *
- *
+ * \htmlonly
\endhtmlonly * The first option is a valid ISO * Language Code. 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: - *
+ * \htmlonly
\endhtmlonly * 
  * \code
  *       ULOC_US
  * \endcode
  *
- *
+ * \htmlonly
\endhtmlonly * *

* Once you've specified a locale you can query it for information about @@ -119,7 +119,7 @@ * operations. For example, the unum_xxx functions format * numbers, currency, or percentages in a locale-sensitive manner. *

- *
+ * \htmlonly
\endhtmlonly * 
  * \code
  *     UErrorCode success = U_ZERO_ERROR;
@@ -134,10 +134,10 @@
  *     unum_close(nf);
  * \endcode
  *
- *
+ * \htmlonly
\endhtmlonly * Each of these methods has two variants; one with an explicit locale * and one without; the latter using the default locale. - *
+ * \htmlonly
\endhtmlonly * 
  * \code 
  * 
@@ -149,7 +149,7 @@
  *     unum_close(nf);
  * \endcode
  *
- *
+ * \htmlonly
\endhtmlonly * A Locale is the mechanism for identifying the kind of services * (UNumberFormat) that you would like to get. The locale is * just 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: - *
+ * \htmlonly
\endhtmlonly * 
  * \code
  *       const char* uloc_getAvailable(int32_t index);
@@ -177,7 +177,7 @@
  * 
  * \endcode
  *
- *
+ * \htmlonly
\endhtmlonly *

* Concerning POSIX/RFC1766 Locale IDs, * the getLanguage/getCountry/getVariant/getName functions do understand diff --git a/icu4c/source/common/unicode/uniset.h b/icu4c/source/common/unicode/uniset.h index f21baa2e59b..bae57622ae4 100644 --- a/icu4c/source/common/unicode/uniset.h +++ b/icu4c/source/common/unicode/uniset.h @@ -68,7 +68,7 @@ class RuleCharacterIterator; * similar to that employed by version 8 regular expression character * classes. Here are some simple examples: * - *

+ * \htmlonly
\endhtmlonly * * * @@ -99,7 +99,7 @@ class RuleCharacterIterator; * * *
[]All characters in the general category Uppercase Letter
- *
+ * \htmlonly
\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; * *

Formal syntax

* - *
+ * \htmlonly
\endhtmlonly * * * @@ -250,7 +250,7 @@ class RuleCharacterIterator; * * *
pattern := 
- *
+ * \htmlonly
\endhtmlonly * * @author Alan Liu * @stable ICU 2.0 diff --git a/icu4c/source/i18n/unicode/calendar.h b/icu4c/source/i18n/unicode/calendar.h index 864242c8735..c83aade9df2 100644 --- a/icu4c/source/i18n/unicode/calendar.h +++ b/icu4c/source/i18n/unicode/calendar.h @@ -73,11 +73,11 @@ typedef int32_t UFieldResolutionTable[12][8]; * object of this type. Calendar's createInstance method * returns the appropriate Calendar subclass whose * time fields have been initialized with the current date and time: - *
+ * \htmlonly
\endhtmlonly * 
  * Calendar *rightNow = Calendar::createInstance(errCode);
  *
- *
+ * \htmlonly
\endhtmlonly * *

* A Calendar 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. * - *

+ * \htmlonly
\endhtmlonly * 
  * 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
  *
- *
+ * \htmlonly
\endhtmlonly * * For the time of day: * - *
+ * \htmlonly
\endhtmlonly * 
  * HOUR_OF_DAY
  * AM_PM + HOUR
  *
- *
+ * \htmlonly
\endhtmlonly * *

* Note: for some non-Gregorian calendars, different diff --git a/icu4c/source/i18n/unicode/choicfmt.h b/icu4c/source/i18n/unicode/choicfmt.h index de94c33f87d..9d909366830 100644 --- a/icu4c/source/i18n/unicode/choicfmt.h +++ b/icu4c/source/i18n/unicode/choicfmt.h @@ -131,9 +131,9 @@ class MessageFormat; * X and and index value j in the range * 0..n-1, where n is the number of ranges:

* - *
X matches j if and only if + * \htmlonly
\endhtmlonlyX matches j if and only if * limit[j] <= X < limit[j+1] - *
+ * \htmlonly
\endhtmlonly * *

(This assumes that all closures are FALSE. If some * closures are TRUE then the relations must be changed to diff --git a/icu4c/source/i18n/unicode/coll.h b/icu4c/source/i18n/unicode/coll.h index d2fc046a9fb..7468eebcb59 100644 --- a/icu4c/source/i18n/unicode/coll.h +++ b/icu4c/source/i18n/unicode/coll.h @@ -99,7 +99,7 @@ class CollationKey; *

* The following example shows how to compare two strings using the * Collator for the default locale. -*

+* \htmlonly
\endhtmlonly * 
 * \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
 *
-*
+* \htmlonly
\endhtmlonly *

* You can set a Collator's strength 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. -*

+* \htmlonly
\endhtmlonly * 
 * \code
 * //Get the Collator for US English and set its strength to PRIMARY 
@@ -136,7 +136,7 @@ class CollationKey;
 * endl;
 * \endcode
 *
-*
+* \htmlonly
\endhtmlonly *

* For comparing strings exactly once, the compare method * provides the best performance. When sorting a list of strings however, it diff --git a/icu4c/source/i18n/unicode/timezone.h b/icu4c/source/i18n/unicode/timezone.h index 9a38eb05a9c..d12c8189594 100644 --- a/icu4c/source/i18n/unicode/timezone.h +++ b/icu4c/source/i18n/unicode/timezone.h @@ -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 TimeZone object * with: - *

+ * \htmlonly
\endhtmlonly * 
  * TimeZone *tz = TimeZone::createTimeZone("PST");
  *
- *
+ * \htmlonly
\endhtmlonly * You can use getAvailableIDs method to iterate through * all the supported time zone IDs. You can then choose a * supported ID to get a TimeZone. @@ -65,11 +65,11 @@ class StringEnumeration; * supported IDs, then you can create a custom time zone ID with * the following syntax: * - *
+ * \htmlonly
\endhtmlonly * 
  * GMT[+|-]hh[[:]mm]
  *
- *
+ * \htmlonly
\endhtmlonly * * For example, you might specify GMT+14:00 as a custom * time zone ID. The TimeZone that is returned @@ -450,7 +450,7 @@ public: * blockquote>
      * .     TimeZone* foo = TimeZone::createTimeZone("America/New_York");
      * .     foo.setID("America/Los_Angeles");
-     *
+ * \htmlonly\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.) * diff --git a/icu4c/source/i18n/unicode/translit.h b/icu4c/source/i18n/unicode/translit.h index f2ec3038e75..a55ffb2f101 100644 --- a/icu4c/source/i18n/unicode/translit.h +++ b/icu4c/source/i18n/unicode/translit.h @@ -69,8 +69,8 @@ class TransliteratorIDParser; * transliteration. For example, given a string input * and a transliterator t, the call * - *
String result = t.transliterate(input); - *
+ * \htmlonly
\endhtmlonlyString result = t.transliterate(input); + * \htmlonly
\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; * *

Consider the simple RuleBasedTransliterator: * - *

+ * \htmlonly
\endhtmlonly * th>{theta}
* t>{tau} - *
+ * \htmlonly
\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: * - *
+ * \htmlonly
\endhtmlonly * t>|{tau}
* {tau}h>{theta} - *
+ * \htmlonly
\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 BA, which transliterates 'B' to 'A'. It might * seem that these are exact inverses, since * - *
"A" x AB -> "B"
- * "B" x BA -> "A"
+ * \htmlonly
\endhtmlonly"A" x AB -> "B"
+ * "B" x BA -> "A"\htmlonly
\endhtmlonly * * where 'x' represents transliteration. However, * - *
"ABCD" x AB -> "BBCD"
- * "BBCD" x BA -> "AACD"
+ * \htmlonly
\endhtmlonly"ABCD" x AB -> "BBCD"
+ * "BBCD" x BA -> "AACD"\htmlonly
\endhtmlonly * * so AB composed with BA is not the * identity. Nonetheless, BA may be usefully considered to be diff --git a/icu4c/source/i18n/unicode/ucal.h b/icu4c/source/i18n/unicode/ucal.h index 114f35ec5dc..df50e69ec69 100644 --- a/icu4c/source/i18n/unicode/ucal.h +++ b/icu4c/source/i18n/unicode/ucal.h @@ -36,7 +36,7 @@ * UCalendar 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. - *
+ * \htmlonly
\endhtmlonly * 
  * \code
  * UCalendar *caldef;
@@ -47,7 +47,7 @@
  * caldef=ucal_open(tzID, u_strlen(tzID), NULL, UCAL_TRADITIONAL, &status);
  * \endcode
  *
- *
+ * \htmlonly
\endhtmlonly * *

* A UCalendar 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. * - *

+ * \htmlonly
\endhtmlonly * 
  * \code
  * UCAL_MONTH + UCAL_DAY_OF_MONTH
@@ -84,18 +84,18 @@
  * UCAL_DAY_OF_WEEK + UCAL_WEEK_OF_YEAR
  * \endcode
  *
- *
+ * \htmlonly
\endhtmlonly * * For the time of day: * - *
+ * \htmlonly
\endhtmlonly * 
  * \code
  * UCAL_HOUR_OF_DAY
  * UCAL_AM_PM + UCAL_HOUR
  * \endcode
  *
- *
+ * \htmlonly
\endhtmlonly * *

* Note: for some non-Gregorian calendars, different