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

ICU-2565 fix doxygen warnings

Browse Source 
X-SVN-Rev: 10758
This commit is contained in:
Alan Liu 2002-12-19 00:43:21 +00:00
parent 5d1328c2bf
commit 03a1aa77bc
8 changed files with 51 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
icu4c/source/common/unicode/rep.h
View File

@ -76,7 +76,7 @@ public:
/**
* Returns the number of 16-bit code units in the text.
* @return number of 16-bit code units in text
* @since ICU 1.8
* @stable ICU 1.8
*/
inline int32_t length() const;
@ -85,7 +85,7 @@ public:
* @param offset an integer between 0 and <code>length()</code>-1
* inclusive
* @return 16-bit code unit of text at given offset
* @since ICU 1.8
* @stable ICU 1.8
*/
inline UChar charAt(int32_t offset) const;
@ -99,7 +99,7 @@ public:
* @param offset an integer between 0 and <code>length()</code>-1
* inclusive
* @return 32-bit code point of text at given offset
* @since ICU 1.8
* @stable ICU 1.8
*/
inline UChar32 char32At(int32_t offset) const;
@ -111,7 +111,7 @@ public:
* be copied
* @param target UnicodeString into which to copy characters.
* @return A reference to <TT>target</TT>
* @since ICU 2.1
* @stable ICU 2.1
*/
virtual void extractBetween(int32_t start,
int32_t limit,
@ -174,7 +174,7 @@ public:
* to the Replaceable API may be optimized to improve performance.
* The default implementation returns true.
* @return true if this object contains metadata
* @since ICU 2.2
* @stable ICU 2.2
*/
virtual UBool hasMetaData() const;
@ -182,21 +182,25 @@ protected:
/**
* Default constructor.
* @draft ICU 2.4
*/
Replaceable();
/**
* Virtual version of length().
* @draft ICU 2.4
*/
virtual int32_t getLength() const = 0;
/**
* Virtual version of charAt().
* @draft ICU 2.4
*/
virtual UChar getCharAt(int32_t offset) const = 0;
/**
* Virtual version of char32At().
* @draft ICU 2.4
*/
virtual UChar32 getChar32At(int32_t offset) const = 0;
};

3
icu4c/source/common/unicode/unifilt.h
View File

@ -68,11 +68,13 @@ public:
/**
* UnicodeFunctor API. Cast 'this' to a UnicodeMatcher* pointer
* and return the pointer.
* @draft ICu 2.4
*/
virtual UnicodeMatcher* toMatcher() const;
/**
* Implement UnicodeMatcher API.
* @draft ICu 2.4
*/
virtual UMatchDegree matches(const Replaceable& text,
int32_t& offset,
@ -81,6 +83,7 @@ public:
/**
* UnicodeFunctor API. Nothing to do.
* @draft ICu 2.4
*/
virtual void setData(const TransliterationRuleData*) {}

6
icu4c/source/common/unicode/unifunct.h
View File

@ -23,6 +23,7 @@ class TransliterationRuleData;
* <code>UnicodeFunctor</code> is an abstract base class for objects
* that perform match and/or replace operations on Unicode strings.
* @author Alan Liu
* @draft ICu 2.4
*/
class U_COMMON_API UnicodeFunctor : public UObject {
@ -30,6 +31,7 @@ class U_COMMON_API UnicodeFunctor : public UObject {
/**
* Destructor
* @draft ICu 2.4
*/
virtual ~UnicodeFunctor();
@ -37,6 +39,7 @@ class U_COMMON_API UnicodeFunctor : public UObject {
* Return a copy of this object. All UnicodeFunctor objects
* have to support cloning in order to allow classes using
* UnicodeFunctor to implement cloning.
* @draft ICu 2.4
*/
virtual UnicodeFunctor* clone() const = 0;
@ -48,6 +51,7 @@ class U_COMMON_API UnicodeFunctor : public UObject {
* cannot be cast to a pointer to a UnicodeMatcher, since
* UnicodeMatcher is a mixin that does not derive from
* UnicodeFunctor.
* @draft ICu 2.4
*/
virtual UnicodeMatcher* toMatcher() const;
@ -59,6 +63,7 @@ class U_COMMON_API UnicodeFunctor : public UObject {
* cannot be cast to a pointer to a UnicodeReplacer, since
* UnicodeReplacer is a mixin that does not derive from
* UnicodeFunctor.
* @draft ICu 2.4
*/
virtual UnicodeReplacer* toReplacer() const;
@ -96,6 +101,7 @@ class U_COMMON_API UnicodeFunctor : public UObject {
* @return The class ID for this object. All objects of a given
* class have the same class ID. Objects of other classes have
* different class IDs.
* @draft ICu 2.4
*/
virtual UClassID getDynamicClassID(void) const = 0;

9
icu4c/source/common/unicode/unimatch.h
View File

@ -19,6 +19,7 @@ class UnicodeSet;
/**
* Constants returned by <code>UnicodeMatcher::matches()</code>
* indicating the degree of match.
* @draft ICu 2.4
*/
enum UMatchDegree {
/**
@ -26,6 +27,7 @@ enum UMatchDegree {
* mismatch between the text and this matcher. The text contains
* a character which does not match, or the text does not contain
* all desired characters for a non-incremental match.
* @draft ICu 2.4
*/
U_MISMATCH,
@ -37,6 +39,7 @@ enum UMatchDegree {
* complete match. Alternatively, for variable-length matchers,
* all characters of the text match, and if more characters were
* supplied at limit, they might also match.
* @draft ICu 2.4
*/
U_PARTIAL_MATCH,
@ -46,6 +49,7 @@ enum UMatchDegree {
* incremental variable-length match, this value is returned if
* the given text matches, and it is known that additional
* characters would not alter the extent of the match.
* @draft ICu 2.4
*/
U_MATCH
};
@ -53,6 +57,7 @@ enum UMatchDegree {
/**
* <code>UnicodeMatcher</code> defines a protocol for objects that can
* match a range of characters in a Replaceable string.
* @draft ICu 2.4
*/
class U_COMMON_API UnicodeMatcher /* not : public UObject because this is an interface/mixin class */ {
@ -107,6 +112,7 @@ public:
* @return a match degree value indicating a full match, a partial
* match, or a mismatch. If incremental is FALSE then
* U_PARTIAL_MATCH should never be returned.
* @draft ICu 2.4
*/
virtual UMatchDegree matches(const Replaceable& text,
int32_t& offset,
@ -123,6 +129,7 @@ public:
* character to their hex escape representations, \uxxxx or
* \Uxxxxxxxx. Unprintable characters are those other than
* U+000A, U+0020..U+007E.
* @draft ICu 2.4
*/
virtual UnicodeString& toPattern(UnicodeString& result,
UBool escapeUnprintable = FALSE) const = 0;
@ -132,6 +139,7 @@ public:
* & 0xFF == v, at offset, in the forward direction (with limit >
* offset). This is used by <tt>RuleBasedTransliterator</tt> for
* indexing.
* @draft ICu 2.4
*/
virtual UBool matchesIndexValue(uint8_t v) const = 0;
@ -139,6 +147,7 @@ public:
* Union the set of all characters that may be matched by this object
* into the given set.
* @param toUnionTo the set into which to union the source characters
* @draft ICu 2.4
*/
virtual void addMatchSetTo(UnicodeSet& toUnionTo) const = 0;
};

3
icu4c/source/i18n/unicode/smpdtfmt.h
View File

@ -826,8 +826,11 @@ public:
/**
* If a start date is set to this value, that indicates that the system default
* start is in effect for this instance.
* @internal
* @obsolete ICU 2.8 Use parseAmbiguousDatesAsAfter instead, since this member will be removed in that release.
*/
static const UDate fgSystemDefaultCentury;
// TODO Not supposed to be public: make it private in 2.8!
};
inline UDate

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

@ -438,10 +438,18 @@ public:
/**
* Enum for use with getDisplayName
* @draft ICU 2.4
*/
enum EDisplayType {
/**
* Selector for short display name
* @draft ICU 2.4
*/
SHORT = 1,
/**
* Selector for long display name
* @draft ICU 2.4
*/
LONG
};

8
icu4c/source/i18n/unicode/translit.h
View File

@ -259,7 +259,15 @@ private:
* @draft ICU 2.4
*/
union Token {
/**
* This token, interpreted as a 32-bit integer.
* @draft ICU 2.4
*/
int32_t integer;
/**
* This token, interpreted as a native pointer.
* @draft ICU 2.4
*/
void* pointer;
};

4
icu4c/source/i18n/unicode/unirepl.h
View File

@ -26,6 +26,7 @@ class UnicodeSet;
*
* <p>This is a mixin class.
* @author Alan Liu
* @draft ICu 2.4
*/
class U_I18N_API UnicodeReplacer /* not : public UObject because this is an interface/mixin class */ {
@ -53,6 +54,7 @@ class U_I18N_API UnicodeReplacer /* not : public UObject because this is an inte
* of a transliteration rule, at least one must update it.
* @return the number of 16-bit code units in the text replacing
* the characters at offsets start..(limit-1) in text
* @draft ICu 2.4
*/
virtual int32_t replace(Replaceable& text,
int32_t start,
@ -71,6 +73,7 @@ class U_I18N_API UnicodeReplacer /* not : public UObject because this is an inte
* \\Uxxxxxxxx. Unprintable characters are defined by
* Utility.isUnprintable().
* @return a reference to 'result'.
* @draft ICu 2.4
*/
virtual UnicodeString& toReplacerPattern(UnicodeString& result,
UBool escapeUnprintable) const = 0;
@ -79,6 +82,7 @@ class U_I18N_API UnicodeReplacer /* not : public UObject because this is an inte
* Union the set of all characters that may output by this object
* into the given set.
* @param toUnionTo the set into which to union the output characters
* @draft ICu 2.4
*/
virtual void addReplacementSetTo(UnicodeSet& toUnionTo) const = 0;
};