* -# The method returns E_INVALID_STATE if the time field is invalid.
*
* @section CompCalendarAddTimeFieldSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
*
* @par When working in Tizen:
* -# The method returns E_INVALID_ARG if the time field is invalid.
* -# The method returns E_INVALID_STATE and E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid.
*
* @section CompCalendarAfterSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
*
* @par When working in Tizen:
* -# The method returns E_INVALID_ARG if the instance of %Calendar to be compared is invalid.
* -# The method returns E_INVALID_STATE and E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid.
*
* @section CompCalendarBeforeSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
*
* @par When working in Tizen:
* -# The method returns E_INVALID_ARG if the instance of %Calendar to be compared is invalid.
* -# The method returns E_INVALID_STATE if the time field is invalid.
*
* @section CompCalendarRollSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
*
* @par When working in Tizen:
* -# The method returns E_INVALID_ARG if the time field is invalid.
* -# The method returns E_UNSUPPORTED_OPERATION if the locale is invalid.
*
* @section CompCalendarCreateInstanceNSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
* -# The method returns E_INVALID_ARG if the locale is invalid.
* @endif
* -# The method returns E_UNSUPPORTED_OPERATION if the locale is invalid.
*
* @section CompCalendarConstructSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
* -# The method returns E_INVALID_ARG if the locale is invalid.
* @endif
* -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid.
*
* @section CompCurrencyConstructSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen.
* @par When working in Tizen:
* -# The method returns E_INVALID_ARG if the argument is invalid.
* @endif
*
* The form of time zone ID is "Area/Location". @n
*
- * However, the specialized time zone IDs have the different form, such as CST6CDT, EST5EDT and so on.@n
+ * However, the specialized time zone IDs have the different form, such as CST6CDT, EST5EDT and so on. @n
*
* For more information on IDs, refer <a href="http://www.iana.org/time-zones" target="_blank">Time Zone Database</a>. @n
*
/**
* Vibrates the device with the specified pattern and level. @n
- * This method returns the result immediately so that the vibration occurs simultaneously as the device runs.
+ * The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs.
* If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately.
*
* @since 2.0
* @param[in] count The number of times to execute the given pattern @n
* It should be greater than @c 0.
* @param[in] level The vibration level @n
- * Ranges from [@c 0~ @c 100], where ' @c 0' is a special case indicating the system default level.
+ * Ranges from [@c 0~ @c 100], where '@c 0' is a special case indicating the system default level.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_ARG A specified input parameter is invalid.
/**
* Vibrates the device for the specified duration at the specified @c level. @n
- * This method returns the result immediately so that the vibration occurs simultaneously as the device runs.
+ * The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs.
* If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately.
*
* @since 2.0
* @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_
/**
* 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
*
/**
* 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
*
* @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()
* @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()
*
* @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()
*/
*
* @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()
*
* The %Decoder class converts blocks of encoded bytes into blocks of Unicode characters
* through successive calls to the GetCharsN() method. This class maintains state consistency information between
- * successive calls to GetCharsN(), enabling it to decode a sequence of bytes that span adjacent blocks.
+ * successive calls to %GetCharsN(), enabling it to decode a sequence of bytes 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>.
*
* @param[in] byteIndex The index from where 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
- * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
* else @c false
+ * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance
* @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_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 specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks The GetCharsN() method maintains state consistency between conversions.
+ * @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::WcharBuffer instance is not terminated by a @c null character.
* @see Encoder::GetBytesN()
*
* 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(), enabling 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>.
* @brief This is the header file for the %Encoding class.
*
* This header file contains the declarations of the %Encoding class. @n
- * The %Encoding class is the base class for all character encoding classes.
+ * This class is the base class for all character encoding classes.
*/
#ifndef _FTEXT_ENCODING_H_
#define _FTEXT_ENCODING_H_
virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::String& str) const = 0;
/**
- * Encodes an instance of specified Tizen::Base::WcharBuffer into an instance of Tizen::Base::ByteBuffer as per the specified range. @n
+ * Encodes an instance of the specified Tizen::Base::WcharBuffer into an instance of Tizen::Base::ByteBuffer as per the specified range. @n
* The position and limit of the %Tizen::Base::ByteBuffer instance is not changed.
*
* @since 2.0
*
* @return An instance of %Encoding, @n
* else @c null if the method fails
- * @param[in] encodingType An encoding type @n
+ * @param[in] encodingType An 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
* @brief This is the header file for the %GsmEncoding class.
*
* This header file contains the declarations of the %GsmEncoding class.
- * The %GsmEncoding class is derived from the Encoding class.
+ * This class is derived from the Encoding class.
*/
#ifndef _FTEXT_GSM_ENCODING_H_
#define _FTEXT_GSM_ENCODING_H_
virtual ~GsmEncoding(void);
/**
- * Gets the total number of bytes that are required to encode a specified Tizen::Base::String instance.
+ * Gets the total number of bytes that are required to encode the specified Tizen::Base::String instance.
*
* @since 2.0
*
virtual result GetByteCount(const Tizen::Base::String& str, int& byteCount) const;
/**
- * Gets the total number of bytes that are required to encode a specified Tizen::Base::WcharBuffer instance.
+ * Gets the total number of bytes that are required to encode the specified Tizen::Base::WcharBuffer instance.
*
* @since 2.0
*
* @brief This is the header file for the %Latin1Encoding class.
*
* This header file contains the declarations of the %Latin1Encoding class.
- * The %Latin1Encoding class is derived from the Encoding class.
+ * This class is derived from the Encoding class.
*/
#ifndef _FTEXT_LATIN1_ENCODING_H_
#define _FTEXT_LATIN1_ENCODING_H_
* 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 %Latin1Encoding class.
-
*
* @code
* #include <FBase.h>
* @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_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 a Tizen::Base::WcharBuffer into a range of bytes in a Tizen::Base::ByteBuffer.
+ * @remarks This method encodes a range of characters in Tizen::Base::WcharBuffer into a range of bytes in Tizen::Base::ByteBuffer.
* @see GetChars()
*/
virtual result GetBytes(const Tizen::Base::WcharBuffer& chars, int charIndex, int charCount,
* @brief This is the header file for the %Ucs2Encoding class.
*
* This header file contains the declarations of the %Ucs2Encoding class.
- * The %Ucs2Encoding class is derived from the Encoding class.
+ * This class is derived from the Encoding class.
*/
#ifndef _FTEXT_UCS2_ENCODING_H_
#define _FTEXT_UCS2_ENCODING_H_
* @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_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks GetByteCount() determines the exact number of bytes
+ * @remarks This method determines the exact number of bytes
* that are produced if the given array of characters is encoded.
* @see GetMaxByteCount()
*/
* @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 GetCharCount() determines the exact number of characters
+ * @remarks This method determines the exact number of characters
* that are produced if the given range of bytes is converted.
* @see GetMaxCharCount()
*/
* @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 specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks GetCharCount() determines the exact number of characters
+ * @remarks This method determines the exact number of characters
* that are produced if the given range of bytes is converted.
* @see GetMaxCharCount()
*/
*
* @return The maximum number of bytes required for encoding the 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()
*/
*
* @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 GetByteCount()
* @see GetChars()
* @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 specified string contains code points that are outside the bounds of the character encoding scheme.
- * @remarks The GetCharsN() method maintains state consistency between conversions.
+ * @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.
*
* 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>.
*
* The following example demonstrates how to use the %Utf8Encoder class.
-
*
* @code
* #include <FBase.h>
* @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_
* 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>
/**
* 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
*
/**
* 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
/**
* 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
*
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
*
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
*
/**
* 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
/**
* 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
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
*
*
* @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()
*/
*
* @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()
projects / platform / framework / native / appfw.git / commitdiff