Enable build with iniparser v 3.1
[platform/framework/native/appfw.git] / inc / FBaseCharacter.h
index 61966cc..483894e 100644 (file)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -148,7 +147,7 @@ public:
         *      @li == 0  if the value of the current instance is equal to the value of the input instance
         *      @li >  0  if the value of the current instance is greater than the value of the input instance
         *      @endcode
-        *      
+        *
         */
        int CompareTo(const Character& value) const;
 
@@ -159,7 +158,7 @@ public:
         *      @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
+        *      @param[in]      obj     The object to compare with the calling object
         *      @see                    Tizen::Base::Object::Equals()
         */
        virtual bool Equals(const Object& obj) const;
@@ -193,7 +192,7 @@ public:
         *
         *      @brief  <i> [Deprecated] </i>
         *      @deprecated This method is deprecated as a new method has been introduced.
-        *      Instead of using this method, use 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 English alphabets.
         *
         *      @since 2.0
         *      @endif
@@ -217,7 +216,7 @@ public:
         *
         *      @brief  <i> [Deprecated] </i>
         *      @deprecated This method is deprecated as a new method has been introduced.
-        *      Instead of using this method, use ToUpperCase() method that supports the Unicode characters other than English alphabets.
+        *      Instead of using this method, use the ToUpperCase() method that supports the Unicode characters other than English alphabets.
         *
         *      @since 2.0
         *      @endif
@@ -276,7 +275,7 @@ public:
         *
         *      @brief  <i> [Deprecated] </i>
         *      @deprecated This method is deprecated as a new method has been introduced.
-        *      Instead of using this method, use 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 the Unicode characters other than English alphabets.
         *
         *      @since 2.0
         *      @return         An lowercase equivalent of the input Unicode character
@@ -303,7 +302,7 @@ public:
         *
         *      @brief  <i> [Deprecated] </i>
         *      @deprecated This method is deprecated as a new method has been introduced.
-        *      Instead of using this method, use 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 English alphabets.
         *
         *      @since 2.0
         *      @return         An uppercase equivalent of the input Unicode character
@@ -332,7 +331,7 @@ public:
         *      @since 2.0
         *      @if OSPCOMPAT
         *      @compatibility  This method has compatibility issues with OSP compatible applications. @n
-        *                      For more information, see @ref CompCharacterIsAlphaNumericPage "here".
+        *                                      For more information, see @ref CompCharacterIsAlphaNumericPage "here".
         *      @endif
         *      @return         @c true if the input character is alphanumeric, @n
         *                              else @c false
@@ -344,13 +343,13 @@ public:
         *      @if OSPCOMPAT
         *      @page                   CompCharacterIsAlphaNumericPage Compatibility for IsAlphaNumeric()
         *      @section                CompCharacterIsAlphaNumericPageIssueSection Issues
-        *                              Implementing this method in OSP compatible applications has the following issues: @n
+        *                                      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.
         *
         *      @section                CompCharacterIsAlphaNumericPageSolutionSection Resolutions
         *
-        *      This issue has been resolved in Tizen. @n
+        *      This issue has been resolved in Tizen.
         *      @endif
         */
 
@@ -374,7 +373,7 @@ public:
         *      @since 2.0
         *      @if OSPCOMPAT
         *      @compatibility  This method has compatibility issues with OSP compatible applications. @n
-        *                      For more information, see @ref CompCharacterIsLetterPage "here".
+        *                                      For more information, see @ref CompCharacterIsLetterPage "here".
         *      @endif
         *      @return         @c true if the input character is an alphabet, @n
         *                              else @c false
@@ -386,26 +385,26 @@ public:
         *      @if OSPCOMPAT
         *      @page                   CompCharacterIsLetterPage Compatibility for IsLetter()
         *      @section                CompCharacterIsLetterPageIssueSection Issues
-        *                              Implementing this method in OSP compatible applications has the following issues: @n
+        *                                      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.
         *
         *      @section                CompCharacterIsLetterPageSolutionSection Resolutions
         *
-        *      This issue has been resolved in Tizen. @n
+        *      This issue has been resolved in Tizen.
         *      @endif
         */
 
        /**
         *      @if OSPDEPREC
-        *      Checks whether the input character is an lowercase alphabet.
+        *      Checks whether the input character is a lowercase alphabet.
         *
         *      @brief  <i> [Deprecated] </i>
         *      @deprecated This method is deprecated as a new method has been introduced.
-        *      Instead of using this method, use 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 an lowercase English alphabet, @n
+        *      @return         @c true if the input character is a lowercase English alphabet, @n
         *                              else @c false
         *      @param[in]      ch      The Unicode character
         *      @endif
@@ -413,12 +412,12 @@ public:
        static bool IsLower(wchar_t ch);
 
        /**
-        *      Checks whether the input character is an lowercase alphabet. @n
+        *      Checks whether the input character is a lowercase alphabet. @n
         *      Unicode characters other than English alphabets are also supported.
         *
         *      @since 2.0
         *
-        *      @return         @c true if the input character is an lowercase alphabet, @n
+        *      @return         @c true if the input character is a lowercase alphabet, @n
         *                              else @c false
         *      @param[in]      ch The Unicode character
         */
@@ -430,7 +429,7 @@ public:
         *
         *      @brief  <i> [Deprecated] </i>
         *      @deprecated This method is deprecated as a new method has been introduced.
-        *      Instead of using this method, use 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 English alphabets.
         *      @since 2.0
         *
         *      @return         @c true if the input character is an uppercase alphabet, @n
@@ -454,7 +453,7 @@ public:
 
        /**
         *      Returns the value of the input character in the supplied radix. @n
-        * The value of radix must be between RADIX_MIN and RADIX_MAX.
+        *      The value of radix must be between RADIX_MIN and RADIX_MAX.
         *
         *      @since 2.0
         *
@@ -466,11 +465,12 @@ public:
 
        /**
         *      Returns the value which represents the input digit with specified radix. @n
-        * The value of radix must be between RADIX_MIN and RADIX_MAX.
+        *      The value of radix must be between RADIX_MIN and RADIX_MAX.
         *
         *      @since 2.0
         *
-        *      @return         A Unicode character of the input digit with specified radix; null character (U+0000) otherwise
+        *      @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
         *      @param[in]      radix   The radix
         */
@@ -478,7 +478,7 @@ public:
 
        /**
         *      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 @c int value.
         *
         *      @since 2.0
         *
@@ -493,7 +493,7 @@ public:
         *      @since 2.0
         *
         *      @return         @c true if the Unicode character is an assigned character, @n
-        *                          else @c false
+        *                              else @c false
         *      @param[in]      ch      A Unicode character
         */
        static bool IsDefined(wchar_t ch);
@@ -505,7 +505,7 @@ public:
         *      @since 2.0
         *
         *      @return         @c true if the Unicode character is a whitespace character, @n
-        *                          else @c false
+        *                              else @c false
         *      @param[in]      ch      A Unicode character
         *
         *      @code
@@ -530,7 +530,7 @@ public:
         *      @since 2.0
         *
         *      @return         @c true if the Unicode character is a title character, @n
-        *                          else @c false
+        *                              else @c false
         *      @param[in]      ch      A Unicode character
         */
        static bool IsTitleCase(wchar_t ch);
@@ -540,7 +540,7 @@ public:
         *
         *      @since 2.0
         *
-        *      @return         A title case character equivalent for the input character. The character itself is returned if none is defined
+        *      @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
         */
        static wchar_t ToTitleCase(wchar_t ch);
@@ -551,7 +551,7 @@ public:
         *      @since 2.0
         *
         *      @return         @c true if the Unicode character is an ISO control character, @n
-        *                          else @c false
+        *                              else @c false
         *      @param[in]      ch      A Unicode character
         */
        static bool IsISOControl(wchar_t ch);
@@ -572,8 +572,8 @@ public:
        static const wchar_t VALUE_MIN = 0x0000;
 
        /**
-        * The minimum radix available for conversion to and from strings.@n
-        * As value as RADIX_BINARY.
+        * The minimum radix available for conversion to and from strings. @n
+        * Same value as RADIX_BINARY.
         *
         * @since 2.0
         */
@@ -630,7 +630,7 @@ private:
        wchar_t __val;
 
        friend class _CharacterImpl;
-       class _CharacterImpl * __pCharacterImpl;
+       class _CharacterImpl* __pCharacterImpl;
 
 }; // Character