X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFTextEncoding.h;h=e12bec281a7c1cded660e4de17f39789f2d180b6;hb=9b44315473e675bcd332e2f56fac1ce00f87a8a6;hp=8654e2795088251b6896db4a5738658ece729d73;hpb=08cd4b841ccdef1cfc0ea1de06a2787cdcfa199f;p=platform%2Fframework%2Fnative%2Fappfw.git
diff --git a/inc/FTextEncoding.h b/inc/FTextEncoding.h
index 8654e27..e12bec2 100644
--- a/inc/FTextEncoding.h
+++ b/inc/FTextEncoding.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);
@@ -48,7 +47,7 @@ namespace Tizen { namespace Text
*
* For more information on the class features, see Converting All Text Data at Once.
*
- * For more information on the supported encoding types, see Encoding standards in %Tizen.
*
* The following example demonstrates how to use the %Encoding class.
*
@@ -118,7 +117,9 @@ public:
* @param[in] str The string to encode
* @param[out] byteCount The total number of bytes that are required to encode the specified string
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str is an empty string.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str is an empty string.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified string is encoded.
@@ -132,10 +133,12 @@ public:
* @since 2.0
*
* @return An error code
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[out] byteCount The total number of bytes required to encode the specified range of characters
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[out] byteCount The total number of bytes required to encode the specified range of characters
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified array of characters are encoded.
@@ -151,13 +154,19 @@ public:
*
* @return An error code
* @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
* @param[out] byteCount The total number of bytes that are required to encode the specified range of characters
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method determines the total number of bytes
* that are generated when the specified array of characters are encoded.
@@ -175,7 +184,7 @@ public:
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last encoded byte plus one and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c chars is invalid or empty.
@@ -194,7 +203,7 @@ public:
* @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last encoded byte plus one and the position is zero.
- * @param[in] str The string to encode
+ * @param[in] str The string to encode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c str is invalid or is an empty string.
@@ -211,17 +220,25 @@ public:
* @since 2.0
*
* @return An error code
- * @param[in] chars The buffer containing the character array to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] chars The buffer that contains the character array to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @param[in] charCount The total number of characters to encode
* @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
* @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c chars or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input paramter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks This method encodes a range of characters in Tizen::Base::WcharBuffer into a range of bytes in Tizen::Base::ByteBuffer.
* @see GetChars()
@@ -236,17 +253,25 @@ public:
* @since 2.0
*
* @return An error code
- * @param[in] str The string to encode
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
- * @param[in] charCount The total number of characters to encode
- * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
- * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
+ * @param[in] str The string to encode
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] charCount The total number of characters to encode
+ * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
+ * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str or @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c str or @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c bytes does not contain sufficient space to store the encoded characters.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetString()
*/
@@ -263,7 +288,9 @@ public:
* @param[out] charCount The total number of characters that are generated by decoding a range of bytes in the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - 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 This method determines the total number of characters
* that are generated when the specified range of bytes are encoded.
@@ -279,14 +306,20 @@ public:
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
+ * @param[in] byteIndex The index from where the decoding begins
* @param[in] byteCount The total number of bytes to decode
* @param[out] charCount The total number of characters that are generated by decoding a range of bytes in the specified Tizen::Base::ByteBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount 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 This method determines the total number of characters
* that are generated when the specified range of bytes are encoded.
@@ -303,7 +336,7 @@ public:
* @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n
* else @c null if an exception occurs @n
* The buffer limit is the position of the last decoded byte plus one and the starting position is zero.
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified @c bytes is invalid or empty.
@@ -320,17 +353,25 @@ public:
* @since 2.0
*
* @return An error code
- * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] byteIndex The index from where decoding begins
- * @param[in] byteCount The total number of bytes to decode
- * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
- * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance
+ * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
+ * @param[in] byteIndex The index from where the decoding begins
+ * @param[in] byteCount The total number of bytes to decode
+ * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored
+ * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
- * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c chars does not contain sufficient space to store the decoded bytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes.
+ * @exception E_OVERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to overflow.
+ * - The specified @c chars does not contain sufficient space to store the decoded bytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @see GetBytes()
*/
@@ -348,7 +389,9 @@ public:
* It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - 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.
*
* @see GetBytesN()
@@ -363,15 +406,21 @@ public:
*
* @return An error code
* @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode
- * @param[in] index The index from where decoding begins
+ * @param[in] index The index from where the decoding begins
* @param[in] count The total number of bytes to decode
- * @param[out] str A Tizen::Base::String instance @n
- * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
+ * @param[out] str A Tizen::Base::String instance @n
+ * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, 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_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_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c bytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - 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_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - 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.
* @see GetBytes()
* @see GetString()
@@ -387,7 +436,6 @@ public:
* @param[in] charCount The total number of characters to encode
* @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding.
* @see GetByteCount()
- * @see GetBytes()
*/
virtual int GetMaxByteCount(int charCount) const = 0;
@@ -401,7 +449,6 @@ public:
* @remarks This method determines an appropriate buffer size for character arrays passed to
* GetChars() or a decoder for encoding.
* @see GetCharCount()
- * @see GetChars()
*/
virtual int GetMaxCharCount(int byteCount) const = 0;
@@ -411,10 +458,10 @@ public:
* @since 2.0
*
* @return A pointer to the Encoder instance for the current encoding
- * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into
- * partial sequences of bytes by maintaining an appropriate state between the conversions.
- * Currently, only UTF-8 encoding supports this method. The other classes return a value of @c null.
- * @see GetBytes()
+ * @remarks
+ * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into
+ * partial sequences of bytes by maintaining an appropriate state between the conversions.
+ * - Currently, only UTF-8 encoding supports this method. The other classes return a @c null value.
*/
virtual Encoder* GetEncoderN(void) const = 0;
@@ -424,10 +471,10 @@ public:
* @since 2.0
*
* @return A pointer to the Decoder instance for the current encoding
- * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes
- * into partial sequences of characters by maintaining an appropriate state between the conversions.
- * Currently, only UTF-8 encoding supports this method. The other classes return a value of @c null.
- * @see GetChars()
+ * @remarks
+ * - Contrary to GetChars(), a decoder can convert partial sequences of bytes
+ * into partial sequences of characters by maintaining an appropriate state between the conversions.
+ * - Currently, only UTF-8 encoding supports this method. The other classes return a @c null value.
*/
virtual Decoder* GetDecoderN(void) const = 0;
@@ -436,62 +483,57 @@ public:
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
*/
virtual Tizen::Base::String GetEncodingType(void) const = 0;
/**
- * Gets an encoding for the UTF-8 format.
+ * Gets the encoding for the UTF-8 format.
*
* @since 2.0
*
- * @return An encoding for the UTF-8 format
+ * @return The encoding for the UTF-8 format
*
- * @see Tizen::Text::Utf8Encoding
*/
static Utf8Encoding& GetUtf8Encoding(void);
/**
- * Gets an encoding for the UCS-2 format.
+ * Gets the encoding for the UCS-2 format.
*
* @since 2.0
*
- * @return An encoding for the UCS-2 format
+ * @return The encoding for the UCS-2 format
-*
- * @see Tizen::Text::Ucs2Encoding
*/
static Ucs2Encoding& GetUcs2Encoding(void);
/**
- * Gets an encoding for the GSM format.
+ * Gets the encoding for the GSM format.
*
* @since 2.0
*
- * @return An encoding for the GSM format
+ * @return The encoding for the GSM format
*
- * @see Tizen::Text::GsmEncoding
*/
static GsmEncoding& GetGsmEncoding(void);
/**
- * Gets an encoding for the Latin1 format.
+ * Gets the encoding for the Latin1 format.
*
* @since 2.0
*
- * @return An encoding for the Latin1 format
+ * @return The encoding for the Latin1 format
*
- * @see Tizen::Text::Latin1Encoding
*/
static Latin1Encoding& GetLatin1Encoding(void);
/**
- * Gets an encoding for the ASCII format.
+ * Gets the encoding for the ASCII format.
*
* @since 2.0
*
- * @return An encoding for the ASCII format
+ * @return The encoding for the ASCII format
*
- * @see Tizen::Text::AsciiEncoding
*/
static AsciiEncoding& GetAsciiEncoding(void);
@@ -500,16 +542,18 @@ public:
*
* @since 2.0
*
- * @return An instance of %Encoding, @n
- * else @c null if the method fails
- * @param[in] encodingType An encoding type
+ * @return An instance of %Encoding, @n
+ * else @c null if it fails
+ * @param[in] encodingType The encoding type
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_TYPE The specified encoding type is not supported.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * The supported encoding types are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, @n
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The supported encoding types are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, @n
* UTF-32, UTF-32LE, UTF-32BE, ISO-8859-1~16 (except ISO-8859-12), Windows-874, Windows-1250 ~ Windows-1258, @n
- * KSC5601, BIG5, GB2312, Shift-JIS and ISO-2022-jp. @n
- * For more information on the supported encoding types, see Encoding standards in %Tizen.
* @see Tizen::Text::Encoding::GetAvailableEncodingsN()
*/
static Encoding* GetEncodingN(const Tizen::Base::String& encodingType);
@@ -519,7 +563,7 @@ public:
*
* @since 2.0
*
- * @return An encoding type
+ * @return The encoding type
* @param[in] encoding An instance of %Encoding
*/
static Tizen::Base::String GetEncodingType(const Encoding& encoding);
@@ -529,8 +573,8 @@ public:
*
* @since 2.0
*
- * @return A list of Tizen::Base::String instances (ASCII, UTF-8, ISO-8859-1, ISO-8859-2, Windows-1254, and so on), @n
- * else @c null if the method fails
+ * @return The list of Tizen::Base::String instances (ASCII, UTF-8, ISO-8859-1, ISO-8859-2, Windows-1254, and so on), @n
+ * else @c null if it fails
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
@@ -542,15 +586,17 @@ public:
*
* @since 2.0
*
- * @return A new buffer for storing the result of the conversion, @n
+ * @return The new buffer for storing the result of the conversion, @n
* else @c null if an exception occurs @n
- * The buffer limit is the position of the last converted byte plus one and the starting position is zero.
+ * The buffer limit is the position of the last converted byte plus one and the starting position is zero.
* @param[in] src The source of the encoding
* @param[in] dst The destination of the encoding
* @param[in] srcBytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c srcBytes is empty.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c srcBytes is empty.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetBytes()
@@ -566,7 +612,7 @@ public:
*
* @return A new buffer for storing result of the conversion, @n
* else @c null if an exception occurs @n
- * The buffer limit is the position of the last converted byte plus one and the starting position is zero.
+ * The buffer limit is the position of the last converted byte plus one and the starting position is zero.
* @param[in] src The source of the encoding
* @param[in] dst The destination of the encoding
* @param[in] srcBytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored
@@ -574,9 +620,15 @@ public:
* @param[in] count The total number of bytes to convert
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c srcBytes is empty.
- * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the specified @c index or @c count is greater than the length of the specified @c srcBytes.
- * @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 srcBytes.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - A specified input parameter is invalid.
+ * - The specified @c srcBytes is empty.
+ * @exception E_OUT_OF_RANGE Either of the following conditions has occurred:
+ * - A specified input parameter is outside the valid range defined by the method.
+ * - The specified @c index or @c count is greater than the length of the specified @c srcBytes.
+ * @exception E_UNDERFLOW Either of the following conditions has occurred:
+ * - This operation has caused the memory to underflow.
+ * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c srcBytes.
* @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @see GetBytes()