ICU-6797 more doxygen cleanup

X-SVN-Rev: 25623
This commit is contained in:
Steven R. Loomis 2009-03-19 02:01:37 +00:00
parent e65d4b6d28
commit 0a5b5e9880
7 changed files with 20 additions and 9 deletions

View file

@ -1,7 +1,7 @@
# Doxyfile 1.3.7
# ********************************************************************
# * COPYRIGHT:
# * Copyright (c) 2004-2008, International Business Machines Corporation
# * Copyright (c) 2004-2009, International Business Machines Corporation
# * and others. All Rights Reserved.
# ********************************************************************
@ -191,7 +191,7 @@ EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = U_EXPORT2= U_STABLE= U_DRAFT= U_INTERNAL= U_SYSTEM= U_DEPRECATED= U_OBSOLETE= U_CALLCONV=
PREDEFINED = U_EXPORT2= U_STABLE= U_DRAFT= U_INTERNAL= U_SYSTEM= U_DEPRECATED= U_OBSOLETE= U_CALLCONV= U_CDECL_BEGIN= U_CDECL_END= U_NO_THROW= U_NAMESPACE_BEGIN= U_NAMESPACE_END=
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------

View file

@ -165,8 +165,8 @@ class U_COMMON_API StringPiece : public UMemory {
* @return the substring StringPiece
* @draft ICU 4.2
*/
StringPiece substr(int32_t pos, int32_t n = npos) const {
return StringPiece(*this, pos, n);
StringPiece substr(int32_t pos, int32_t len = npos) const {
return StringPiece(*this, pos, len);
}
};

View file

@ -1039,7 +1039,7 @@ public:
/**
* @return a code point IF the string consists of a single one.
* otherwise returns -1.
* @param string to test
* @param s string to test
*/
static int32_t getSingleCP(const UnicodeString& s);

View file

@ -190,14 +190,14 @@ public:
/**
* ICU "poor man's RTTI", returns a UClassID for the actual class.
*
* @stable ICU 2.2
* @draft ICU 4.2
*/
virtual UClassID getDynamicClassID() const;
/**
* ICU "poor man's RTTI", returns a UClassID for this class.
*
* @stable ICU 2.2
* @draft ICU 4.2
*/
static UClassID U_EXPORT2 getStaticClassID();

View file

@ -247,6 +247,7 @@ public:
* @return pattern string for currencyMatch, surroundingMatch or spaceInsert.
* Return empty string if there is no data for this locale and its parent
* locales.
* @draft ICU 4.2
*/
const UnicodeString& getPatternForCurrencySpacing(ECurrencySpacing type,
UBool beforeCurrency,
@ -259,6 +260,7 @@ public:
* @param beforeCurrency : true if the pattern is for before currency symbol.
* false if the pattern is for after currency symbol.
* @param pattern : pattern string to override current setting.
* @draft ICU 4.2
*/
void setPatternForCurrencySpacing(ECurrencySpacing type,
UBool beforeCurrency,

View file

@ -1,6 +1,6 @@
/*
**********************************************************************
* Copyright (C) 2004-2008, International Business Machines
* Copyright (C) 2004-2009, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
* file name: regex.h
@ -31,7 +31,7 @@
struct URegularExpression;
/**
* Structure represeting a compiled regular rexpression, plus the results
* Structure representing a compiled regular rexpression, plus the results
* of a match operation.
* @stable ICU 3.0
*/

View file

@ -190,6 +190,7 @@ uspoof_open(UErrorCode *status);
*
* @see uspoof_open
* @see uspoof_serialize
* @draft ICU 4.2
*/
U_CAPI USpoofChecker * U_EXPORT2
uspoof_openFromSerialized(const void *data, int32_t length, int32_t *pActualLength,
@ -224,6 +225,7 @@ uspoof_openFromSerialized(const void *data, int32_t length, int32_t *pActualLeng
* U_PARSE_ERROR, which is used to report syntax errors
* in the input.
* @return A spoof checker that uses the rules from the input files.
* @draft ICU 4.2
*/
U_CAPI USpoofChecker * U_EXPORT2
uspoof_openFromSource(const char *confusables, int32_t confusablesLen,
@ -234,6 +236,7 @@ uspoof_openFromSource(const char *confusables, int32_t confusablesLen,
/**
* Close a Spoof Checker, freeing any memory that was being held by
* its implementation.
* @draft ICU 4.2
*/
U_DRAFT void U_EXPORT2
uspoof_close(USpoofChecker *sc);
@ -245,6 +248,7 @@ uspoof_close(USpoofChecker *sc);
* @param sc The source USpoofChecker
* @param status The error code, set if this function encounters a problem.
* @return
* @draft ICU 4.2
*/
U_DRAFT USpoofChecker * U_EXPORT2
uspoof_clone(const USpoofChecker *sc, UErrorCode *status);
@ -359,6 +363,7 @@ uspoof_getAllowedLocales(USpoofChecker *sc, UErrorCode *status);
* this function, so there are no restrictions on modifying
* or deleting the USet after calling this function.
* @param status The error code, set if this function encounters a problem.
* @draft ICU 4.2
*/
U_DRAFT void U_EXPORT2
uspoof_setAllowedChars(USpoofChecker *sc, const USet *chars, UErrorCode *status);
@ -382,6 +387,7 @@ uspoof_setAllowedChars(USpoofChecker *sc, const USet *chars, UErrorCode *status)
* @param status The error code, set if this function encounters a problem.
* @return A USet containing the characters that are permitted by
* the USPOOF_CHAR_LIMIT test.
* @draft ICU 4.2
*/
U_DRAFT const USet * U_EXPORT2
uspoof_getAllowedChars(const USpoofChecker *sc, UErrorCode *status);
@ -404,6 +410,7 @@ uspoof_getAllowedChars(const USpoofChecker *sc, UErrorCode *status);
* this function, so there are no restrictions on modifying
* or deleting the USet after calling this function.
* @param status The error code, set if this function encounters a problem.
* @draft ICU 4.2
*/
U_DRAFT void U_EXPORT2
uspoof_setAllowedUnicodeSet(USpoofChecker *sc, const UnicodeSet *chars, UErrorCode *status);
@ -427,6 +434,7 @@ uspoof_setAllowedUnicodeSet(USpoofChecker *sc, const UnicodeSet *chars, UErrorCo
* @param status The error code, set if this function encounters a problem.
* @return A UnicodeSet containing the characters that are permitted by
* the USPOOF_CHAR_LIMIT test.
* @draft ICU 4.2
*/
U_DRAFT const UnicodeSet * U_EXPORT2
uspoof_getAllowedUnicodeSet(const USpoofChecker *sc, UErrorCode *status);
@ -794,6 +802,7 @@ uspoof_getSkeletonUnicodeString(const USpoofChecker *sc,
* @return the number of bytes written or needed for the spoof data
*
* @see utrie2_openFromSerialized()
* @draft ICU 4.2
*/
U_CAPI int32_t U_EXPORT2
uspoof_serialize(USpoofChecker *sc,