*
* The %Encoder class converts blocks of characters to blocks of encoded bytes
* through successive calls to the GetBytesN() method. This class maintains the state consistency information between
- * successive calls to %GetBytesN(), enabling it to encode a character into a sequence of bytes,
+ * successive calls to %GetBytesN() and enables it to encode a character into a sequence of bytes,
* such as surrogate pairs, that span adjacent blocks.
*
* 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>.
* @since 2.0
*
* @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] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
- * else @c false
- * @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.
- * @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.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer 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[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n
+ * else @c false
+ * @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_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.
* @see Decoder::GetCharCount()
*/
* @since 2.0
*
* @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 in the buffer and the starting position is zero.
- * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
- * @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 chars is empty.
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte plus one in the buffer and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode
+ * @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 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 The specific error code can be accessed using the GetLastResult() method.
* @see Decoder::GetCharsN()
* @since 2.0
*
* @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 in the buffer and the starting position is zero.
- * @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] 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 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.
+ * else @c null if an exception occurs @n
+ * The buffer limit is the position of the last encoded byte in the buffer and the starting position is zero.
+ * @param[in] chars An instance of Tizen::Base::WcharBuffer 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[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 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 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
+ * - 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.
* @see Decoder::GetCharsN()
*/
virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars, int charIndex, int charCount,
projects / platform / framework / native / appfw.git / blobdiff