*
* The %Utf8Decoder class converts blocks of bytes into decoded blocks of characters.
* Universal Transformation Format-8 (UTF-8) is a translated language that is used on the internet.
- * It converts the unicode into 8-bit bytes.
- * UTF-8 encoding supports all unicode character values and surrogates.
+ * It converts the Unicode into 8-bit bytes.
+ * UTF-8 encoding supports all Unicode character values and surrogates.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/text/converting_text_data_separate_blocks.htm">Converting Text Data in Separate Blocks</a>.
*
*
* @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 the specified Tizen::Base::ByteBuffer instance
* @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @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_ENCODING_RANGE The conversion has failed due to invalid encoding range.
+ * @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 conversion has failed due to an invalid encoding range.
*/
virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, int& charCount, bool flush = false) const;
*
* @since 2.0
*
- * @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] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @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_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
+ * @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] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @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 The specific error code can be accessed using the GetLastResult() method.
*/
virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, bool flush = false) const;
* Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer as per the specified range.
*
* @since 2.0
- * @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 and the starting position is zero.
+ * @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 and the starting position is zero.
* @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[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
* else @c false
* @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 maintains state consistency between conversions.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
- *
+ * @remarks
+ * - This method maintains state consistency between conversions.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character.
*/
virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount,
bool flush = false) const;
projects / platform / framework / native / appfw.git / blobdiff