From a078bb1ce8e4338a594a35d8a31d317a90eb067a Mon Sep 17 00:00:00 2001 From: George Rhoten Date: Tue, 2 Nov 2004 04:55:53 +0000 Subject: [PATCH] ICU-4053 Fix some doxygen warnings. X-SVN-Rev: 16719 --- icu4c/source/common/unicode/docmain.h | 2 +- icu4c/source/common/unicode/unistr.h | 4 ++-- icu4c/source/common/unicode/uset.h | 2 +- icu4c/source/i18n/unicode/rbnf.h | 5 +++-- icu4c/source/i18n/unicode/uregex.h | 7 +++++++ icu4c/source/i18n/unicode/utmscale.h | 4 ++-- 6 files changed, 16 insertions(+), 8 deletions(-) diff --git a/icu4c/source/common/unicode/docmain.h b/icu4c/source/common/unicode/docmain.h index 7c2afbb5597..2e488c9f715 100644 --- a/icu4c/source/common/unicode/docmain.h +++ b/icu4c/source/common/unicode/docmain.h @@ -166,7 +166,7 @@ * * * Regular Expressions - * N/A + * uregex.h * RegexPattern, RegexMatcher * * diff --git a/icu4c/source/common/unicode/unistr.h b/icu4c/source/common/unicode/unistr.h index f9e8520246f..090c706adf5 100644 --- a/icu4c/source/common/unicode/unistr.h +++ b/icu4c/source/common/unicode/unistr.h @@ -1431,13 +1431,13 @@ public: * @param startLength the number of characters to extract * @param target the target buffer for extraction, can be NULL * if targetLength is 0 - * @param targetLength the length of the target buffer + * @param targetCapacity the length of the target buffer * @param inv Signature-distinguishing paramater, use US_INV. * @return the output string length, not including the terminating NUL * @draft ICU 3.2 */ int32_t extract(int32_t start, - int32_t length, + int32_t startLength, char *target, int32_t targetCapacity, enum EInvariant inv) const; diff --git a/icu4c/source/common/unicode/uset.h b/icu4c/source/common/unicode/uset.h index a67b6a27f87..304d9e86af0 100644 --- a/icu4c/source/common/unicode/uset.h +++ b/icu4c/source/common/unicode/uset.h @@ -387,7 +387,7 @@ uset_removeString(USet* set, const UChar* str, int32_t strLen); * set so that its value is the asymmetric set difference of * the two sets. * @param set the object from which the elements are to be removed - * @param remove the object that defines which elements will be + * @param removeSet the object that defines which elements will be * removed from this set * @draft ICU 3.2 */ diff --git a/icu4c/source/i18n/unicode/rbnf.h b/icu4c/source/i18n/unicode/rbnf.h index 34be006126b..cc778ab699e 100644 --- a/icu4c/source/i18n/unicode/rbnf.h +++ b/icu4c/source/i18n/unicode/rbnf.h @@ -531,7 +531,7 @@ public: * with the first String being the ULocale ID, and the remaining * Strings being the localizations of the rule set names, in the * same order as the initial array. Arrays are NULL-terminated. - * @param description A description of the formatter's desired behavior. + * @param rules A description of the formatter's desired behavior. * See the class documentation for a complete explanation of the description * syntax. * @param localizations the localization information. @@ -683,7 +683,8 @@ public: /** * Return the index'th display name locale. * @param index the index of the locale - * @param return the locale + * @param status set to a failure code when this function fails + * @return the locale * @see #getNumberOfRuleSetDisplayNameLocales * @draft ICU 3.2 */ diff --git a/icu4c/source/i18n/unicode/uregex.h b/icu4c/source/i18n/unicode/uregex.h index 65887567129..5c37bc84e88 100644 --- a/icu4c/source/i18n/unicode/uregex.h +++ b/icu4c/source/i18n/unicode/uregex.h @@ -13,6 +13,13 @@ * ICU Regular Expressions, API for C */ +/** + * \file + * \brief C API: Regular Expressions + * + *

This is a C wrapper around the C++ RegexPattern and RegexMatcher classes.

+ */ + #ifndef UREGEX_H #define UREGEX_H diff --git a/icu4c/source/i18n/unicode/utmscale.h b/icu4c/source/i18n/unicode/utmscale.h index 2ea3802108e..212e275f9e0 100644 --- a/icu4c/source/i18n/unicode/utmscale.h +++ b/icu4c/source/i18n/unicode/utmscale.h @@ -416,7 +416,7 @@ typedef enum UTimeScaleValue { * * @param timeScale The time scale * @param value A constant representing the value to get - * + * @param status The status code. Set to U_ILLEGAL_ARGUMENT_ERROR if arguments are invalid. * @return - the value. * * @draft ICU 3.2 @@ -445,7 +445,7 @@ U_DRAFT int64_t U_EXPORT2 /** * Convert a datetime from the universal time scale to a int64_t in the given time scale. * - * @param universal The datetime in the universal time scale + * @param universalTime The datetime in the universal time scale * @param timeScale The time scale to convert to * @param status The status code. Set to U_ILLEGAL_ARGUMENT_ERROR if the conversion is out of range. *