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

ICU-3820 Fix doxygen warnings

Browse Source 
X-SVN-Rev: 15817
This commit is contained in:
George Rhoten 2004-06-09 21:30:50 +00:00
parent 2263af12ff
commit f86db7f63e
6 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -446,7 +446,7 @@ public:
* Returns an instance of a BreakIterator implementing title breaks.
* The iterator returned locates title boundaries as described for
* Unicode 3.2 only. For Unicode 4.0 and above title boundary iteration,
* please use Word Boundary iterator.{@link createWordInstance }
* please use Word Boundary iterator.{@link #createWordInstance }
*
* @param where the locale.
* @param status The error code.

8
icu4c/source/common/unicode/normlzr.h
View File

@ -593,12 +593,12 @@ public:
* Set the normalization mode for this object.
* <p>
* <b>Note:</b>If the normalization mode is changed while iterating
* over a string, calls to {@link next() } and {@link previous() } may
* over a string, calls to {@link #next() } and {@link #previous() } may
* return previously buffers characters in the old normalization mode
* until the iteration is able to re-sync at the next base character.
* It is safest to call {@link setIndexOnly }, {@link reset() },
* {@link setText }, {@link first() },
* {@link last() }, etc. after calling <code>setMode</code>.
* It is safest to call {@link #setIndexOnly }, {@link #reset() },
* {@link #setText }, {@link #first() },
* {@link #last() }, etc. after calling <code>setMode</code>.
* <p>
* @param newMode the new mode for this <code>Normalizer</code>.
* @see #getUMode

12
icu4c/source/i18n/unicode/ucol.h
View File

@ -252,7 +252,7 @@ typedef enum {
* Open a UCollator for comparing strings.
* The UCollator pointer is used in all the calls to the Collation
* service. After finished, collator must be disposed of by calling
* \Ref{ucol_close}.
* {@link #ucol_close }.
* @param loc The locale containing the required collation rules.
* Special values for locales can be passed in -
* if NULL is passed for the locale, the default locale
@ -272,7 +272,7 @@ ucol_open(const char *loc, UErrorCode *status);
* Produce an UCollator instance according to the rules supplied.
* The rules are used to change the default ordering, defined in the
* UCA in a process called tailoring. The resulting UCollator pointer
* can be used in the same way as the one obtained by \Ref{ucol_strcoll}.
* can be used in the same way as the one obtained by {@link #ucol_strcoll }.
* @param rules A string describing the collation rules. For the syntax
* of the rules please see users guide.
* @param rulesLength The length of rules, or -1 if null-terminated.
@ -391,7 +391,7 @@ ucol_strcoll( const UCollator *coll,
/**
* Determine if one string is greater than another.
* This function is equivalent to \Ref{ucol_strcoll} == UCOL_GREATER
* This function is equivalent to {@link #ucol_strcoll } == UCOL_GREATER
* @param coll The UCollator containing the comparison rules.
* @param source The source string.
* @param sourceLength The length of source, or -1 if null-terminated.
@ -410,7 +410,7 @@ ucol_greater(const UCollator *coll,
/**
* Determine if one string is greater than or equal to another.
* This function is equivalent to \Ref{ucol_strcoll} != UCOL_LESS
* This function is equivalent to {@link #ucol_strcoll } != UCOL_LESS
* @param coll The UCollator containing the comparison rules.
* @param source The source string.
* @param sourceLength The length of source, or -1 if null-terminated.
@ -429,7 +429,7 @@ ucol_greaterOrEqual(const UCollator *coll,
/**
* Compare two strings for equality.
* This function is equivalent to \Ref{ucol_strcoll} == UCOL_EQUAL
* This function is equivalent to {@link #ucol_strcoll } == UCOL_EQUAL
* @param coll The UCollator containing the comparison rules.
* @param source The source string.
* @param sourceLength The length of source, or -1 if null-terminated.
@ -523,7 +523,7 @@ ucol_getAvailable(int32_t index);
/**
* Determine how many locales have collation rules available.
* This function is most useful as determining the loop ending condition for
* calls to \Ref{ucol_getAvailable}.
* calls to {@link #ucol_getAvailable }.
* @return The number of locales for which collation rules are available.
* @see ucol_getAvailable
* @stable ICU 2.0

14
icu4c/source/i18n/unicode/udat.h
View File

@ -355,8 +355,8 @@ typedef enum UDateFormatField {
/**
* Open a new UDateFormat for formatting and parsing dates and times.
* A UDateFormat may be used to format dates in calls to \Ref{udat_format},
* and to parse dates in calls to \Ref{udat_parse}.
* A UDateFormat may be used to format dates in calls to {@link #udat_format },
* and to parse dates in calls to {@link #udat_parse }.
* @param timeStyle The style used to format times; one of UDAT_FULL, UDAT_LONG,
* UDAT_MEDIUM, UDAT_SHORT, or UDAT_DEFAULT
* @param dateStyle The style used to format dates; one of UDAT_FULL, UDAT_LONG,
@ -406,7 +406,7 @@ udat_clone(const UDateFormat *fmt,
/**
* Format a date using an UDateFormat.
* The date will be formatted using the conventions specified in \Ref{udat_open}
* The date will be formatted using the conventions specified in {@link #udat_open }
* @param format The formatter to use
* @param dateToFormat The date to format
* @param result A pointer to a buffer to receive the formatted number.
@ -432,7 +432,7 @@ udat_format( const UDateFormat* format,
/**
* Parse a string into an date/time using a UDateFormat.
* The date will be parsed using the conventions specified in \Ref{udat_open}
* The date will be parsed using the conventions specified in {@link #udat_open }
* @param format The formatter to use.
* @param text The text to parse.
* @param textLength The length of text, or -1 if null-terminated.
@ -452,7 +452,7 @@ udat_parse( const UDateFormat* format,
/**
* Parse a string into an date/time using a UDateFormat.
* The date will be parsed using the conventions specified in \Ref{udat_open}
* The date will be parsed using the conventions specified in {@link #udat_open }
* @param format The formatter to use.
* @param calendar The calendar in which to store the parsed data.
* @param text The text to parse.
@ -561,7 +561,7 @@ udat_getAvailable(int32_t index);
/**
* Determine how many locales have date/time formatting patterns available.
* This function is most useful as determining the loop ending condition for
* calls to \Ref{udat_getAvailable}.
* calls to {@link #udat_getAvailable }.
* @return The number of locales for which date/time formatting patterns are available.
* @see udat_getAvailable
* @stable ICU 2.0
@ -688,7 +688,7 @@ udat_getSymbols(const UDateFormat *fmt,
/**
* Count the number of particular symbols for an UDateFormat.
* This function is most useful as for detemining the loop termination condition
* for calls to \Ref{udat_getSymbols}.
* for calls to {@link #udat_getSymbols }.
* @param fmt The formatter to query.
* @param type The type of symbols to count. One of UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS,
* UDAT_WEEKDAYS, UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, or UDAT_LOCALIZED_CHARS

12
icu4c/source/i18n/unicode/umsg.h
View File

@ -240,7 +240,7 @@ u_vformatMessage( const char *locale,
* Parse a message.
* For numeric arguments, this function will always use doubles. Integer types
* should not be passed.
* This function is not able to parse all output from \Ref{u_formatMessage}.
* This function is not able to parse all output from {@link #u_formatMessage }.
* @param locale The locale for which the message is formatted
* @param pattern The pattern specifying the message's format
* @param patternLength The length of pattern
@ -265,7 +265,7 @@ u_parseMessage( const char *locale,
* Parse a message.
* For numeric arguments, this function will always use doubles. Integer types
* should not be passed.
* This function is not able to parse all output from \Ref{u_formatMessage}.
* This function is not able to parse all output from {@link #u_formatMessage }.
* @param locale The locale for which the message is formatted
* @param pattern The pattern specifying the message's format
* @param patternLength The length of pattern
@ -349,7 +349,7 @@ u_vformatMessageWithError( const char *locale,
* Parse a message.
* For numeric arguments, this function will always use doubles. Integer types
* should not be passed.
* This function is not able to parse all output from \Ref{u_formatMessage}.
* This function is not able to parse all output from {@link #u_formatMessage }.
* @param locale The locale for which the message is formatted
* @param pattern The pattern specifying the message's format
* @param patternLength The length of pattern
@ -377,7 +377,7 @@ u_parseMessageWithError(const char *locale,
* Parse a message.
* For numeric arguments, this function will always use doubles. Integer types
* should not be passed.
* This function is not able to parse all output from \Ref{u_formatMessage}.
* This function is not able to parse all output from {@link #u_formatMessage }.
* @param locale The locale for which the message is formatted
* @param pattern The pattern specifying the message's format
* @param patternLength The length of pattern
@ -554,7 +554,7 @@ umsg_vformat( const UMessageFormat *fmt,
* Parse a message.
* For numeric arguments, this function will always use doubles. Integer types
* should not be passed.
* This function is not able to parse all output from \Ref{umsg_format}.
* This function is not able to parse all output from {@link #umsg_format }.
* @param fmt The formatter to use
* @param source The text to parse.
* @param sourceLength The length of source, or -1 if null-terminated.
@ -576,7 +576,7 @@ umsg_parse( const UMessageFormat *fmt,
* Parse a message.
* For numeric arguments, this function will always use doubles. Integer types
* should not be passed.
* This function is not able to parse all output from \Ref{umsg_format}.
* This function is not able to parse all output from {@link #umsg_format }.
* @param fmt The formatter to use
* @param source The text to parse.
* @param sourceLength The length of source, or -1 if null-terminated.

6
icu4c/source/i18n/unicode/unum.h
View File

@ -193,8 +193,8 @@ typedef enum UNumberFormatPadPosition {
/**
* Create and return a new UNumberFormat for formatting and parsing
* numbers. A UNumberFormat may be used to format numbers by calling
* \Ref{unum_format}, and to parse numbers by calling \Ref{unum_parse}.
* The caller must call \Ref{unum_close} when done to release resources
* {@link #unum_format }, and to parse numbers by calling {@link #unum_parse }.
* The caller must call {@link #unum_close } when done to release resources
* used by this object.
* @param style The type of number format to open: one of
* UNUM_DECIMAL, UNUM_CURRENCY, UNUM_PERCENT, UNUM_SCIENTIFIC, UNUM_SPELLOUT,
@ -509,7 +509,7 @@ unum_getAvailable(int32_t index);
* Determine how many locales have decimal formatting patterns available. The
* results of this call are not valid for rule-based number formats.
* This function is useful for determining the loop ending condition for
* calls to \Ref{unum_getAvailable}.
* calls to {@link #unum_getAvailable }.
* @return The number of locales for which decimal formatting patterns are available.
* @see unum_getAvailable
* @stable ICU 2.0