ICU-2589 Fix some doxygen warnings.

X-SVN-Rev: 11881
This commit is contained in:
George Rhoten 2003-05-10 00:27:54 +00:00
parent b2427b6e75
commit 3283cb8b1b
2 changed files with 18 additions and 17 deletions

View File

@ -219,7 +219,7 @@ typedef enum UNormalizationCheckResult {
* *
* @param source string for determining if it is in a normalized format * @param source string for determining if it is in a normalized format
* @param sourcelength length of source to test, or -1 if NUL-terminated * @param sourcelength length of source to test, or -1 if NUL-terminated
* @paran mode which normalization form to test for * @param mode which normalization form to test for
* @param status a pointer to a UErrorCode to receive any errors * @param status a pointer to a UErrorCode to receive any errors
* @return UNORM_YES, UNORM_NO or UNORM_MAYBE * @return UNORM_YES, UNORM_NO or UNORM_MAYBE
* *
@ -237,7 +237,7 @@ unorm_quickCheck(const UChar *source, int32_t sourcelength,
* *
* @param src String that is to be tested if it is in a normalization format. * @param src String that is to be tested if it is in a normalization format.
* @param srcLength Length of source to test, or -1 if NUL-terminated. * @param srcLength Length of source to test, or -1 if NUL-terminated.
* @paran mode Which normalization form to test for. * @param mode Which normalization form to test for.
* @param options The normalization options, ORed together (0 for no options). * @param options The normalization options, ORed together (0 for no options).
* @param pErrorCode ICU error code in/out parameter. * @param pErrorCode ICU error code in/out parameter.
* Must fulfill U_SUCCESS before the function call. * Must fulfill U_SUCCESS before the function call.
@ -264,7 +264,7 @@ unorm_quickCheckWithOptions(const UChar *src, int32_t srcLength,
* *
* @param src String that is to be tested if it is in a normalization format. * @param src String that is to be tested if it is in a normalization format.
* @param srcLength Length of source to test, or -1 if NUL-terminated. * @param srcLength Length of source to test, or -1 if NUL-terminated.
* @paran mode Which normalization form to test for. * @param mode Which normalization form to test for.
* @param pErrorCode ICU error code in/out parameter. * @param pErrorCode ICU error code in/out parameter.
* Must fulfill U_SUCCESS before the function call. * Must fulfill U_SUCCESS before the function call.
* @return Boolean value indicating whether the source string is in the * @return Boolean value indicating whether the source string is in the
@ -284,7 +284,7 @@ unorm_isNormalized(const UChar *src, int32_t srcLength,
* *
* @param src String that is to be tested if it is in a normalization format. * @param src String that is to be tested if it is in a normalization format.
* @param srcLength Length of source to test, or -1 if NUL-terminated. * @param srcLength Length of source to test, or -1 if NUL-terminated.
* @paran mode Which normalization form to test for. * @param mode Which normalization form to test for.
* @param options The normalization options, ORed together (0 for no options). * @param options The normalization options, ORed together (0 for no options).
* @param pErrorCode ICU error code in/out parameter. * @param pErrorCode ICU error code in/out parameter.
* Must fulfill U_SUCCESS before the function call. * Must fulfill U_SUCCESS before the function call.

View File

@ -52,76 +52,77 @@ public:
* or struct, then we no longer need this enum. * or struct, then we no longer need this enum.
* @draft ICU 2.4 * @draft ICU 2.4
*/ */
enum ISDATE { kIsDate }; enum ISDATE { kIsDate };
/** /**
* Default constructor * Default constructor
* @draft ICU 2.4 * @draft ICU 2.4
*/ */
Formattable(); // Type kLong, value 0 Formattable(); // Type kLong, value 0
/** /**
* Creates a Formattable object with a UDate instance. * Creates a Formattable object with a UDate instance.
* @param d the UDate instance. * @param d the UDate instance.
* @param ISDATE the flag to indicate this is a date. * @param ISDATE the flag to indicate this is a date.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable(UDate d, ISDATE); Formattable(UDate d, ISDATE);
/** /**
* Creates a Formattable object with a double number. * Creates a Formattable object with a double number.
* @param d the double number. * @param d the double number.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable(double d); Formattable(double d);
/** /**
* Creates a Formattable object with a long number. * Creates a Formattable object with a long number.
* @param d the long number. * @param l the long number.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable(int32_t l); Formattable(int32_t l);
/** /**
* Creates a Formattable object with a char string pointer. * Creates a Formattable object with a char string pointer.
* Assumes that the char string is null terminated. * Assumes that the char string is null terminated.
* @param strToCopy the char string. * @param strToCopy the char string.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable(const char* strToCopy); Formattable(const char* strToCopy);
/** /**
* Creates a Formattable object with a UnicodeString object to copy from. * Creates a Formattable object with a UnicodeString object to copy from.
* @param strToCopy the UnicodeString string. * @param strToCopy the UnicodeString string.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable(const UnicodeString& stringToCopy); Formattable(const UnicodeString& strToCopy);
/** /**
* Creates a Formattable object with a UnicodeString object to adopt from. * Creates a Formattable object with a UnicodeString object to adopt from.
* @param strToAdopt the UnicodeString string. * @param strToAdopt the UnicodeString string.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable(UnicodeString* stringToAdopt); Formattable(UnicodeString* strToAdopt);
/** /**
* Creates a Formattable object with an array of Formattable objects. * Creates a Formattable object with an array of Formattable objects.
* @param arrayToCopy the Formattable object array. * @param arrayToCopy the Formattable object array.
* @param count the array count. * @param count the array count.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable(const Formattable* arrayToCopy, int32_t count); Formattable(const Formattable* arrayToCopy, int32_t count);
/** /**
* Copy constructor. * Copy constructor.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable(const Formattable&); Formattable(const Formattable&);
/** /**
* Assignment operator. * Assignment operator.
* @param rhs The Formattable object to copy into this object.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
Formattable& operator=(const Formattable&); Formattable& operator=(const Formattable &rhs);
/** /**
* Equality comparison. * Equality comparison.
* @param other the object to be compared with. * @param other the object to be compared with.
* @return TRUE if other are equal to this, FALSE otherwise. * @return TRUE if other are equal to this, FALSE otherwise.
* @stable ICU 2.0 * @stable ICU 2.0
*/ */
UBool operator==(const Formattable&) const; UBool operator==(const Formattable &other) const;
/** /**
* Equality operator. * Equality operator.