X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseCharacter.h;h=e6af8c6fba8f72e88df04aa2c3dd0c740ba6bdc0;hb=60d143778a54ae4c638a08d8c7304b099f70434e;hp=483894eb185d476d94c875d2f2e5432bdbcbfddb;hpb=3b569ff3e66a065cb5728bc19d1da493c66f7583;p=platform%2Fframework%2Fnative%2Fappfw.git
diff --git a/inc/FBaseCharacter.h b/inc/FBaseCharacter.h
index 483894e..e6af8c6 100644
--- a/inc/FBaseCharacter.h
+++ b/inc/FBaseCharacter.h
@@ -32,32 +32,32 @@ namespace Tizen { namespace Base
/**
* @enum UnicodeCategory
*
- * Defines the constants used to distinguish the categories of Unicode characters.
+ * Defines the constants used to distinguish the categories of the Unicode characters.
*
* @since 2.0
*/
enum UnicodeCategory
{
- UNICODE_SURROGATE = 1, /**< The surrogate Unicode category */
- UNICODE_MODIFIER, /**< The spacing modifier Unicode category */
- UNICODE_ARROW, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_SPACE, /**< The space Unicode category */
- UNICODE_PUNCTUATION, /**< The punctuation Unicode category */
- UNICODE_CONTROL, /**< The control Unicode category */
- UNICODE_MATH, /**< The math Unicode category */
- UNICODE_DIGIT, /**< The digit Unicode category */
- UNICODE_HANGUL, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_HANJA, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_COMBINING, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_LANGUAGE, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/
- UNICODE_UPPERCASE, /**< The uppercase Unicode category*/
- UNICODE_LOWERCASE, /**< The lowercase Unicode category*/
- UNICODE_TITLECASE, /**< The titlecase Unicode category*/
- UNICODE_LETTER, /**< The letter Unicode category*/
- UNICODE_MARK, /**< The mark Unicode category*/
- UNICODE_CURRENCY, /**< The currency Unicode category*/
- UNICODE_SEPARATOR, /**< The separator Unicode category*/
- UNICODE_OTHER /**< The other Unicode category */
+ UNICODE_SURROGATE = 1, /**< The surrogate Unicode category */
+ UNICODE_MODIFIER, /**< The spacing modifier Unicode category */
+ UNICODE_ARROW, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_SPACE, /**< The space Unicode category */
+ UNICODE_PUNCTUATION, /**< The punctuation Unicode category */
+ UNICODE_CONTROL, /**< The control Unicode category */
+ UNICODE_MATH, /**< The math Unicode category */
+ UNICODE_DIGIT, /**< The digit Unicode category */
+ UNICODE_HANGUL, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_HANJA, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_COMBINING, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_LANGUAGE, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */
+ UNICODE_UPPERCASE, /**< The uppercase Unicode category */
+ UNICODE_LOWERCASE, /**< The lowercase Unicode category */
+ UNICODE_TITLECASE, /**< The titlecase Unicode category */
+ UNICODE_LETTER, /**< The letter Unicode category */
+ UNICODE_MARK, /**< The mark Unicode category */
+ UNICODE_CURRENCY, /**< The currency Unicode category */
+ UNICODE_SEPARATOR, /**< The separator Unicode category */
+ UNICODE_OTHER /**< The other Unicode category */
};
@@ -67,9 +67,9 @@ enum UnicodeCategory
*
* @since 2.0
*
- * The %Character class wraps a value of the @c wchar_t type. It also provides
+ * The %Character class wraps the value of the @c wchar_t type. It also provides
* several methods for determining a Unicode character's category, and for
- * converting the case of intrinsic characters. The class is useful when
+ * converting the case of the intrinsic characters. This class is useful when
* passing a Unicode character to a method expecting an instance of Object.
*
* The following example demonstrates how to use the %Character class.
@@ -80,7 +80,7 @@ enum UnicodeCategory
*
* using namespace Tizen::Base;
*
- * // This method converts the first character of the given @c string to the upper case.
+ * // This method converts the first character of the given string to the upper case.
* void
* MyClass::CharacterSample(String& str)
* {
@@ -104,7 +104,7 @@ public:
*
* @since 2.0
*
- * @param[in] value A multi-byte character used to initialize the %Character instance
+ * @param[in] value The multi-byte character used to initialize the %Character instance
*/
Character(wchar_t value);
@@ -113,7 +113,7 @@ public:
*
* @since 2.0
*
- * @param[in] value An instance of %Character
+ * @param[in] value An instance of %Character to copy
*/
Character(const Character& value);
@@ -129,7 +129,7 @@ public:
*
* @since 2.0
*
- * @param[in] rhs An instance of %Character
+ * @param[in] rhs An instance of %Character to copy
*/
Character& operator =(const Character& rhs);
@@ -139,8 +139,8 @@ public:
*
* @since 2.0
*
- * @return A 32-bit @c signed integer value
- * @param[in] value The character instance to compare with
+ * @return The 32-bit @c signed integer value
+ * @param[in] value The %Character instance to compare with
*
* @code
* @li < 0 if the value of the current instance is less than the value of the input instance
@@ -152,14 +152,14 @@ public:
int CompareTo(const Character& value) const;
/**
- * Checks whether the value of the Object parameter is equal
- * to the value of the calling object.
+ * Checks whether the value of the input Object is equal
+ * to the value of the calling %Object.
*
* @since 2.0
* @return @c true if the input Object is equal to the calling %Object, @n
* else @c false
- * @param[in] obj The object to compare with the calling object
- * @see Tizen::Base::Object::Equals()
+ * @param[in] obj The object to compare with the calling object
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& obj) const;
@@ -169,30 +169,28 @@ public:
* @since 2.0
*
* @return The hash value of the current instance
- * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance,
- * the used hash function must generate a random distribution for all inputs.
+ * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n
+ * For better performance,the used hash function must generate a random distribution for all the inputs.
*/
virtual int GetHashCode(void) const;
/**
- * Returns the value of the current instance as a
- * @c wchar_t.
+ * Returns the value of the current instance as a @c wchar_t value.
*
* @since 2.0
*
- * @return The value of this instance as
- * a @c wchar_t
+ * @return The value of this instance as a @c wchar_t value
*/
wchar_t ToMchar(void) const;
/**
* @if OSPDEPREC
* Converts the Unicode characters of the calling object to its equivalent lowercase. @n
- * The Unicode characters other than English alphabets are not changed.
+ * Unicode characters other than the English alphabets are not changed.
*
- * @brief [Deprecated]
+ * @brief [Deprecated]
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
* @endif
@@ -202,7 +200,7 @@ public:
/**
* Converts the Unicode characters of the calling object to its equivalent lowercase. @n
- * The Unicode characters other than English alphabets are also supported.
+ * Unicode characters other than the English alphabets are also supported.
*
* @since 2.0
*/
@@ -212,11 +210,11 @@ public:
/**
* @if OSPDEPREC
* Converts the Unicode characters of the current object to its equivalent uppercase. @n
- * The Unicode characters other than English alphabets are not changed.
+ * Unicode characters other than the English alphabets are not changed.
*
- * @brief [Deprecated]
+ * @brief [Deprecated]
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToUpperCase() method that supports the Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToUpperCase() method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
* @endif
@@ -226,7 +224,7 @@ public:
/**
* Converts the Unicode characters of the current object to its equivalent uppercase. @n
- * The Unicode characters other than English alphabets are also supported.
+ * Unicode characters other than English alphabets are also supported.
*
* @since 2.0
*/
@@ -234,11 +232,11 @@ public:
/**
- * Returns a string representing the value of the calling %Character instance.
+ * Returns a string that represents the value of the calling %Character instance.
*
* @since 2.0
*
- * @return An instance of String class that
+ * @return An instance of String that
* contains a Unicode representation of the calling instance
*/
String ToString(void) const;
@@ -249,7 +247,7 @@ public:
*
* @since 2.0
*
- * @return An instance of the String class
+ * @return An instance of String
* that contains the Unicode representation of the
* input value
* @param[in] value The Unicode character to convert
@@ -257,12 +255,12 @@ public:
static String ToString(wchar_t value);
/**
- * Categorizes a Unicode character into a group identified by
+ * Categorizes a Unicode character into a group that is identified by
* one of the UnicodeCategory values.
*
* @since 2.0
*
- * @return A value of type UnicodeCategory that identifies the group that contains the specified @c ch
+ * @return The value of type UnicodeCategory that identifies the group that contains the specified @c ch
* @param[in] ch The Unicode character to categorize
*
*/
@@ -271,14 +269,14 @@ public:
/**
* @if OSPDEPREC
* Converts the input Unicode character to its equivalent lowercase. @n
- * The Unicode characters other than English alphabets are not changed.
+ * Unicode characters other than the English alphabets are not changed.
*
- * @brief [Deprecated]
+ * @brief [Deprecated]
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports the Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
- * @return An lowercase equivalent of the input Unicode character
+ * @return The lowercase equivalent of the input Unicode character
* @param[in] ch The Unicode character to convert
* @endif
*/
@@ -286,11 +284,11 @@ public:
/**
* Converts the input Unicode character to its equivalent lowercase. @n
- * The Unicode characters other than English alphabets are also supported.
+ * Unicode characters other than the English alphabets are also supported.
*
* @since 2.0
*
- * @return An lowercase equivalent of the input Unicode character
+ * @return The lowercase equivalent of the input Unicode character
* @param[in] ch The Unicode character to convert
*/
static wchar_t ToLowerCase(wchar_t ch);
@@ -298,14 +296,14 @@ public:
/**
* @if OSPDEPREC
* Converts the input Unicode character to its equivalent uppercase. @n
- * The Unicode characters other than English alphabets are not changed.
+ * Unicode characters other than the English alphabets are not changed.
*
- * @brief [Deprecated]
+ * @brief [Deprecated]
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than the English alphabets.
*
* @since 2.0
- * @return An uppercase equivalent of the input Unicode character
+ * @return The uppercase equivalent of the input Unicode character
* @param[in] ch The Unicode character to convert
* @endif
*/
@@ -313,18 +311,18 @@ public:
/**
* Converts the input Unicode character to its equivalent uppercase. @n
- * The Unicode characters other than English alphabets are also supported.
+ * Unicode characters other than the English alphabets are also supported.
*
* @since 2.0
*
- * @return An uppercase equivalent of the input Unicode character
+ * @return The uppercase equivalent of the input Unicode character
* @param[in] ch The Unicode character to convert
*/
static wchar_t ToUpperCase(wchar_t ch);
/**
* Checks whether the input character is an alphanumeric character (letter or digit). @n
- * A character is considered to be an alphanumeric character if either Character::isLetter(wchar_t ch) or Character::isDigit(wchar_t ch) returns true for the character
+ * A character is considered to be an alphanumeric character if either Character::isLetter(wchar_t ch) or Character::isDigit(wchar_t ch) returns @c true for the character
* @if OSPCOMPAT
* @brief [Compatibility]
* @endif
@@ -345,11 +343,11 @@ public:
* @section CompCharacterIsAlphaNumericPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
*
- * -# The method returns true only if the character is alphabet character and cannot checks other Unicode character in Letter and digit category.
+ * -# The method returns @c true only if the character is an alphabet character, it cannot check other Unicode characters in the letter and digit category.
*
* @section CompCharacterIsAlphaNumericPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen.
+ * This issue mentioned above is resolved in %Tizen.
* @endif
*/
@@ -387,11 +385,11 @@ public:
* @section CompCharacterIsLetterPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
*
- * -# The method returns true only if the character is alphabet character and cannot checks other Unicode character in Letter category.
+ * -# The method returns @c true only if the character is an alphabet character, it cannot check other Unicode characters in the letter category.
*
* @section CompCharacterIsLetterPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen.
+ * This issue mentioned above is resolved in %Tizen.
* @endif
*/
@@ -399,12 +397,12 @@ public:
* @if OSPDEPREC
* Checks whether the input character is a lowercase alphabet.
*
- * @brief [Deprecated]
+ * @brief [Deprecated]
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters.
+ * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters.
* @since 2.0
*
- * @return @c true if the input character is a lowercase English alphabet, @n
+ * @return @c true if the input character is a lowercase alphabet, @n
* else @c false
* @param[in] ch The Unicode character
* @endif
@@ -427,9 +425,9 @@ public:
* @if OSPDEPREC
* Checks whether the input character is an uppercase alphabet.
*
- * @brief [Deprecated]
+ * @brief [Deprecated]
* @deprecated This method is deprecated as a new method has been introduced.
- * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than English alphabets.
+ * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than the English alphabets.
* @since 2.0
*
* @return @c true if the input character is an uppercase alphabet, @n
@@ -452,38 +450,39 @@ public:
static bool IsUpperCase(wchar_t ch);
/**
- * Returns the value of the input character in the supplied radix. @n
- * The value of radix must be between RADIX_MIN and RADIX_MAX.
+ * Returns the value of the input character in the supplied @c radix. @n
+ * The value of @c radix must be between ::RADIX_MIN and ::RADIX_MAX.
*
* @since 2.0
*
- * @return A integer value of the input character in the supplied radix
- * @param[in] ch The character to determine the value
+ * @return The integer value of the input character in the supplied @c radix
+ * @param[in] ch The character that determines the value
* @param[in] radix The radix
*/
static int ToDigit(wchar_t ch, int radix);
/**
- * Returns the value which represents the input digit with specified radix. @n
- * The value of radix must be between RADIX_MIN and RADIX_MAX.
+ * Returns the value which represents the input digit in the specified @c radix. @n
+ * The value of @c radix must be between ::RADIX_MIN and ::RADIX_MAX.
*
* @since 2.0
*
- * @return A Unicode character of the input digit with specified @c radix @n
- * else @c null character (U+0000)
- * @param[in] digit The digit to determine the value
+ * @return The Unicode character of the input digit in the specified @c radix @n
+ * else a @c null character (U+0000)
+ * @param[in] digit The digit that determines the value
* @param[in] radix The radix
*/
static wchar_t ForDigit(int digit, int radix);
/**
* Gets the numeric value of the input unicode character. @n
- * This is used when some numeric values are fractions, negative, or too large for @c int value.
+ * This is used when some numeric values are fractions, negative, or too large for the @c int value.
*
* @since 2.0
*
- * @return A @c double value @n NO_NUMERIC_VALUE for characters without any numeric values in the Unicode %Character.
- * @param[in] ch A Unicode character
+ * @return The @c double value @n
+ * NO_NUMERIC_VALUE is returned for characters without any numeric values in the Unicode character.
+ * @param[in] ch The Unicode character
*/
static double GetNumericValue(wchar_t ch);
@@ -494,7 +493,7 @@ public:
*
* @return @c true if the Unicode character is an assigned character, @n
* else @c false
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*/
static bool IsDefined(wchar_t ch);
@@ -506,10 +505,10 @@ public:
*
* @return @c true if the Unicode character is a whitespace character, @n
* else @c false
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*
* @code
- * It is a Unicode Separator character, but is not also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).
+ * It is a Unicode Separator character, but is also not a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).
* It is U+0009 HORIZONTAL TABULATION.
* It is U+000A LINE FEED.
* It is U+000B VERTICAL TABULATION.
@@ -531,7 +530,7 @@ public:
*
* @return @c true if the Unicode character is a title character, @n
* else @c false
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*/
static bool IsTitleCase(wchar_t ch);
@@ -540,19 +539,20 @@ public:
*
* @since 2.0
*
- * @return A title case character equivalent for the input character @n The character itself is returned if none is defined.
- * @param[in] ch A Unicode character
+ * @return The title case character equivalent for the input character @n
+ * The character itself is returned if no equivalent is defined.
+ * @param[in] ch The Unicode character
*/
static wchar_t ToTitleCase(wchar_t ch);
/**
- * Checks whether the input character is an ISO control code or not.
+ * Checks whether the input character is an ISO control code.
*
* @since 2.0
*
* @return @c true if the Unicode character is an ISO control character, @n
* else @c false
- * @param[in] ch A Unicode character
+ * @param[in] ch The Unicode character
*/
static bool IsISOControl(wchar_t ch);
@@ -565,57 +565,57 @@ public:
static const wchar_t VALUE_MAX = 0x10FFFF;
/**
- * A constant holding the smallest value of type wchar_t, 0x0000.
+ * A constant holding the smallest value of type @c wchar_t, 0x0000.
*
* @since 2.0
*/
static const wchar_t VALUE_MIN = 0x0000;
/**
- * The minimum radix available for conversion to and from strings. @n
- * Same value as RADIX_BINARY.
+ * The minimum radix available for converting to and from strings. @n
+ * Same value as ::RADIX_BINARY.
*
* @since 2.0
*/
static const int RADIX_MIN = 2;
/**
- * The radix for binary number.
+ * The radix for a binary number.
*
* @since 2.0
*/
static const int RADIX_BINARY = 2;
/**
- * The radix for decimal number.
+ * The radix for a decimal number.
*
* @since 2.0
*/
static const int RADIX_DECIMAL = 10;
/**
- * The radix for octal number.
+ * The radix for an octal number.
*
* @since 2.0
*/
static const int RADIX_OCTAL = 8;
/**
- * The radix for hexadecimal number.
+ * The radix for a hexadecimal number.
*
* @since 2.0
*/
static const int RADIX_HEXADECIMAL = 16;
/**
- * The maximum radix available for conversion to and from strings. Same value as RADIX_HEXADECIMAL.
+ * The maximum radix available for converting to and from strings. Same value as ::RADIX_HEXADECIMAL.
*
* @since 2.0
*/
static const int RADIX_MAX = 36;
/**
- * Special value that is returned by GetNumericValue(wchar_t ch) when no numeric value is defined for the unicode character.
+ * The special value that is returned by the GetNumericValue(wchar_t ch) method when no numeric value is defined for the unicode character.
*
* @since 2.0
*/