Implementation of ImmutableString

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

diff --git a/inc/FTextAsciiEncoding.h b/inc/FTextAsciiEncoding.h
index d2124a7..64d2ab0 100644 (file)
--- a/inc/FTextAsciiEncoding.h
+++ b/inc/FTextAsciiEncoding.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 %AsciiEncoding class.
  *
  * This header file contains the declarations of the %AsciiEncoding class. @n
- * The %AsciiEncoding class is derived from the Encoding class.
+ * This class is derived from the Encoding class.
  */
 #ifndef _FTEXT_ASCII_ENCODING_H_
 #define _FTEXT_ASCII_ENCODING_H_
@@ -198,9 +197,8 @@ public:
 
        /**
         * Decodes an instance of the specified Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer. @n
-        * The GetCharsN() method maintains no state consistency between conversions. The method is intended for
-        * conversions of complete blocks of bytes and characters in one operation.
-        * This method decodes in a single step.
+        * The %GetCharsN() method does not maintain state consistency between conversions as this method is intended to
+        * convert complete blocks of bytes and characters in one operation and also to decode it in a single step.
         *
         * @since                       2.0
         *
@@ -220,8 +218,8 @@ public:
        /**
         * Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer as per the specified range. @n
         * The position and limit of the %Tizen::Base::WcharBuffer instance is not changed.
-        * The GetChars() method maintains no state consistency between conversions. The method is intended for
-        * conversions of complete blocks of bytes and characters in one operation.
+        * The %GetChars() method does not maintain state consistency between conversions as this is intended to
+        * convert complete blocks of bytes and characters in one operation.
         *
         * @since                       2.0
         *
@@ -260,7 +258,7 @@ public:
         * @exception   E_INVALID_ARG            A specified input parameter is invalid, or
         *                                         the specified @c bytes is empty.
         * @exception   E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
-        * @remarks     GetString() assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string.
+        * @remarks     This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string.
         *              If the bytes are in multiple byte arrays, use the Decoder class, which maintains state consistency
         *              between multiple calls.
         * @see                         GetBytesN()
@@ -287,7 +285,7 @@ public:
         * @exception E_UNDERFLOW                                This operation has caused the memory to underflow, or
         *                                                                              the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes.
         * @exception   E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
-        * @remarks     GetString() assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string.
+        * @remarks     This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string.
         *              If the bytes are in multiple byte arrays, use the Decoder class, which maintains state consistency
         *              between multiple calls.
         * @see                         GetBytes()
@@ -301,7 +299,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                          Encoding::GetByteCount()
        * @see                          GetBytes()
        */
@@ -314,7 +312,7 @@ public:
         *
         * @return              The maximum number of characters that are 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 character arrays passed to
+        * @remarks   This method determines an appropriate buffer size for character arrays passed to
         *                GetChars() or a decoder for encoding.
         * @see                         Encoding::GetCharCount()
         * @see                         GetChars()