Merge "[2.2.1] Remove error check code in CopyCtor of String" into tizen_2.2

[platform/framework/native/appfw.git] / inc / FTextUtf8Encoding.h

diff --git a/inc/FTextUtf8Encoding.h b/inc/FTextUtf8Encoding.h
index 10035cc..f797162 100644 (file)
--- a/inc/FTextUtf8Encoding.h
+++ b/inc/FTextUtf8Encoding.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -20,7 +19,7 @@
  * @brief              This is the header file for the %Utf8Encoding class.
  *
  * This header file contains the declarations of the %Utf8Encoding class.
- * The %Utf8Encoding class is derived from the Encoding class.
+ * This class is derived from the Encoding class.
  */
 #ifndef _FTEXT_UTF8_ENCODING_H_
 #define _FTEXT_UTF8_ENCODING_H_
@@ -47,7 +46,6 @@ namespace Tizen { namespace Text
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/text/converting_all_text_data.htm">Converting All Text Data at Once</a>.
  *
  * The following example demonstrates how to use the %Utf8Encoding class.
-
  *
  *  @code
  *     #include <FBase.h>
@@ -109,7 +107,7 @@ public:
 
        /**
         * Gets the total number of bytes that are generated by encoding an instance of specified string. @n
-        * The GetByteCount() method determines the total number of bytes that are generated when the specified string is encoded.
+        * The %GetByteCount() method determines the total number of bytes that are generated when the specified string is encoded.
         *
         * @since                       2.0
         *
@@ -126,7 +124,7 @@ public:
 
        /**
         * Gets the total number of bytes that are generated by encoding an instance of specified Tizen::Base::WcharBuffer. @n
-        * The GetByteCount() method determines the exact number of bytes
+        * The %GetByteCount() method determines the exact number of bytes
         * produced if the given array of characters is encoded.
         *
         * @since                       2.0
@@ -144,7 +142,7 @@ public:
 
        /**
         * Gets the total number of bytes that are required to encode a range of characters in the specified Tizen::Base::WcharBuffer instance. @n
-        * The GetByteCount() method determines the total number of bytes that are generated when the specified array of characters is encoded.
+        * The %GetByteCount() method determines the total number of bytes that are generated when the specified array of characters is encoded.
         *
         * @since                       2.0
         *
@@ -166,7 +164,7 @@ public:
        virtual result GetByteCount(const Tizen::Base::WcharBuffer& chars, int charIndex, int charCount, int& byteCount) const;
 
        /**
-        * Encodes an instance of specified Tizen::Base::WcharBuffer into an instance of Tizen::Base::ByteBuffer.
+        * Encodes an instance of the specified Tizen::Base::WcharBuffer into an instance of Tizen::Base::ByteBuffer.
         *
         * @since                       2.0
         *
@@ -184,7 +182,7 @@ public:
        virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars) const;
 
        /**
-        * Encodes an instance of specified Tizen::Base::String into an instance of Tizen::Base::ByteBuffer.
+        * Encodes an instance of the specified Tizen::Base::String into an instance of Tizen::Base::ByteBuffer.
         *
         * @since                       2.0
         *
@@ -260,7 +258,7 @@ public:
 
        /**
         * Gets the total number of characters that are generated by decoding an instance of Tizen::Base::ByteBuffer. @n
-        * The GetCharCount() method determines the exact number of characters
+        * The %GetCharCount() method determines the exact number of characters
         * produced if the given range of bytes is converted.
         *
         * @since                       2.0
@@ -278,7 +276,7 @@ public:
 
        /**
         * Gets the total number of characters that are generated by decoding a range of elements specified in the Tizen::Base::ByteBuffer instance. @n
-        * The GetCharCount() method determines the exact number of characters
+        * The %GetCharCount() method determines the exact number of characters
         * produced if the given range of bytes is converted.
         *
         * @since                       2.0
@@ -301,7 +299,7 @@ public:
        virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, int& charCount) const;
 
        /**
-        * Decodes an instance of specified Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer.
+        * Decodes an instance of the specified Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer.
         *
         * @since                       2.0
         *
@@ -396,7 +394,7 @@ public:
         *
         * @return              The maximum number of bytes required for encoding a given number of characters
         * @param[in]   charCount The total number of characters to encode
-        * @remarks     GetMaxByteCount() determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
+        * @remarks     This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
         * @see                 GetByteCount()
         * @see                 GetBytes()
         */
@@ -410,7 +408,7 @@ public:
        *
        * @return                       The maximum number of characters generated by decoding the specified number of bytes
        * @param[in]            byteCount The total number of bytes to encode
-       * @remarks     GetMaxCharCount() determines an appropriate buffer size for the character arrays passed to
+       * @remarks     This method determines an appropriate buffer size for the character arrays passed to
        *                   GetChars() or a decoder for encoding.
        * @see                  GetCharCount()
        * @see                  GetChars()