From 772f9f028032a8f69ee8cf554fb83bdc6dc65c68 Mon Sep 17 00:00:00 2001 From: Hokwon Song Date: Thu, 24 Oct 2013 14:40:50 +0900 Subject: [PATCH] update reviewed dox. Change-Id: If73ca6256db4ae7d329af7b6afc373e69c9ad4eb Signed-off-by: Hokwon Song --- inc/FLclCalendar.h | 531 +++++++++++---------- inc/FLclCurrency.h | 50 +- inc/FLclDateTimeFormatter.h | 101 ++-- inc/FLclDateTimeSymbols.h | 101 ++-- inc/FLclGregorianCalendar.h | 216 ++++----- inc/FLclLocale.h | 145 +++--- inc/FLclLocaleManager.h | 56 ++- inc/FLclNumberFormatter.h | 189 ++++---- inc/FLclNumberSymbols.h | 53 +- inc/FLclTimeRule.h | 18 +- inc/FLclTimeZone.h | 154 +++--- inc/FLocales.h | 6 +- inc/FSysAlarm.h | 57 ++- inc/FSysBattery.h | 27 +- inc/FSysDeviceManager.h | 71 ++- inc/FSysEnvironment.h | 18 +- inc/FSysIAlarmEventListener.h | 6 +- inc/FSysIBatteryEventListener.h | 10 +- inc/FSysIBootEventListener.h | 6 +- inc/FSysIChargingEventListener.h | 8 +- inc/FSysIDeviceEventListener.h | 8 +- inc/FSysIRuntimeInfoGetIntAsyncResultListener.h | 18 +- ...SysIRuntimeInfoGetLonglongAsyncResultListener.h | 20 +- inc/FSysIScreenEventListener.h | 10 +- inc/FSysISettingEventListener.h | 15 +- inc/FSysISettingInfoSetValueAsyncResultListener.h | 15 +- inc/FSysPowerManager.h | 259 +++++----- inc/FSysRuntimeInfo.h | 119 +++-- inc/FSysSettingInfo.h | 379 ++++++++------- inc/FSysSystemInfo.h | 146 +++--- inc/FSysSystemTime.h | 16 +- inc/FSysVibrator.h | 114 ++--- inc/FSystem.h | 6 +- inc/FText.h | 11 +- inc/FTextAsciiEncoding.h | 223 +++++---- inc/FTextDecoder.h | 78 +-- inc/FTextEncoder.h | 88 ++-- inc/FTextEncoding.h | 235 +++++---- inc/FTextGsmEncoding.h | 231 +++++---- inc/FTextLatin1Encoding.h | 162 ++++--- inc/FTextUcs2Encoding.h | 236 ++++----- inc/FTextUtf8Decoder.h | 77 +-- inc/FTextUtf8Encoder.h | 82 ++-- inc/FTextUtf8Encoding.h | 240 +++++----- 44 files changed, 2433 insertions(+), 2178 deletions(-) diff --git a/inc/FLclCalendar.h b/inc/FLclCalendar.h index 45d3e66..9f8c216 100644 --- a/inc/FLclCalendar.h +++ b/inc/FLclCalendar.h @@ -101,7 +101,7 @@ enum TimeField TIME_FIELD_MILLISECOND, /**< Millisecond : 0-based (0~999) */ TIME_FIELD_ZONE_OFFSET, /**< Time Zone Offset : 0-based (-43200000~54000000 in milliseconds) */ TIME_FIELD_DST_OFFSET, /**< Daylight Saving Offset : 0-based (0~3600000 in milliseconds)*/ - TIME_FIELD_FIELD_COUNT /**< The number of time field */ + TIME_FIELD_FIELD_COUNT /**< The number of time fields */ }; class _OSP_EXPORT_ Calendar @@ -117,8 +117,8 @@ public: virtual ~Calendar(void); /** - * Adds the specified amount to the given time field, based on the calendar rules. @n - * It is equivalent to calling SetTimeField(field, GetTimeField(field)+amount) with two adjustments. @n + * Adds the specified amount to the specified time field, based on the calendar rules. @n + * It is equivalent to calling SetTimeField(field, GetTimeField(field)+amount) with the following two adjustments: @n * * @b Add @b Rule1: The value of the time field @c field after the call minus the value of the field * before the call is delta modulo any overflow that has occurred in the field. @@ -129,48 +129,48 @@ public: * equal to its prior value because of changes in its minimum or maximum value after the time field @c field * is changed, then its value is adjusted to be as close as possible to its expected value. @n * - * A smaller field represents a smaller unit of time. TIME_FIELD_HOUR is a smaller field than TIME_FIELD_DAY_OF_MONTH. + * A smaller field represents a smaller unit of time. @c TIME_FIELD_HOUR is a smaller field than @c TIME_FIELD_DAY_OF_MONTH. * No adjustment is made to smaller fields that are not expected to be invariant. - * The calendar system determines what fields are expected to be invariant. + * The calendar system determines the fields that are expected to be invariant. * * In addition, this method forces re-computation of the calendar's milliseconds and * all time fields immediately. @n * * For example, consider a GregorianCalendar set to Oct 31, 2004. - * Calling AddTimeField(TIME_FIELD_MONTH, 13) sets the calendar to Nov 30, 2005. @n - * The TIME_FIELD_MONTH field is set to NOVEMBER by @b Rule1, since adding 13 months to October gives the + * Calling AddTimeField(@c TIME_FIELD_MONTH, 13) sets the calendar to Nov 30, 2005. @n + * The @c TIME_FIELD_MONTH field is set to NOVEMBER by @b Rule1, since adding 13 months to October sets the month as * November of the next year. - * Since, the TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, the TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2. + * Since, the @c TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, the @c TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarAddTimeFieldPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarAddTimeFieldPage "here". * @endif * * @return An error code * @param[in] field The time field * @param[in] amount The amount to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. */ virtual result AddTimeField(TimeField field, int amount) = 0; /** * @if OSPCOMPAT - * @page CompCalendarAddTimeFieldPage Compatibility for AddTimeField() - * @section CompCalendarAddTimeFieldIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_INVALID_STATE if the time field is invalid. - * - * @section CompCalendarAddTimeFieldSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompCalendarAddTimeFieldPage Compatibility for AddTimeField() + * @section CompCalendarAddTimeFieldIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_INVALID_STATE if the time field is invalid. + * + * @section CompCalendarAddTimeFieldSolutionSection Resolutions + * 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 @c E_INVALID_ARG if the time field is invalid. * @endif */ @@ -180,41 +180,41 @@ public: * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarAfterPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarAfterPage "here". * @endif * - * @return An error code - * @param[in] otherCalendar The instance of %Calendar to compare - * @param[out] after Set to @c true if the current instance of %Calendar is after the specified instance of %Calendar, @n + * @return An error code + * @param[in] otherCalendar The instance of %Calendar to compare + * @param[out] after Set to @c true if the current instance of %Calendar is after the specified instance of %Calendar, @n * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c otherCalendar is invalid. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c otherCalendar is invalid. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n * If any time field value previously set is invalid, this exception is returned. - * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields goes out of range, this exception is returned. */ result After(const Calendar& otherCalendar, bool& after); /** * @if OSPCOMPAT - * @page CompCalendarAfterPage Compatibility for After() - * @section CompCalendarAfterIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# 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. + * @page CompCalendarAfterPage Compatibility for After() + * @section CompCalendarAfterIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_INVALID_STATE and @c E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid. + * + * @section CompCalendarAfterSolutionSection Resolutions + * 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 any time field value previously set is invalid. - * -# The method returns E_OUT_OF_RANGE if the value of the time fields goes out of range. + * -# The method returns @c E_INVALID_ARG if the instance of %Calendar to be compared is invalid. + * -# The method returns @c E_INVALID_STATE if any time field value previously set is invalid. + * -# The method returns @c E_OUT_OF_RANGE if the value of the time fields goes out of range. * @endif - */ + */ /** * Compares the current instance of %Calendar with the specified instance. @@ -222,45 +222,45 @@ public: * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarBeforePage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarBeforePage "here". * @endif * - * @return An error code - * @param[in] otherCalendar The instance of %Calendar to compare - * @param[out] before Set to @c true if the current instance of %Calendar is before the specified instance of %Calendar, @n - * else @c false + * @return An error code + * @param[in] otherCalendar The instance of %Calendar to compare + * @param[out] before Set to @c true if the current instance of %Calendar is before the specified instance of %Calendar, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c otherCalendar is invalid. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @exception E_INVALID_ARG The specified @c otherCalendar is invalid. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields goes out of range, this exception is returned. */ result Before(const Calendar& otherCalendar, bool& before); /** * @if OSPCOMPAT - * @page CompCalendarBeforePage Compatibility for Before() - * @section CompCalendarBeforeIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# 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. + * @page CompCalendarBeforePage Compatibility for Before() + * @section CompCalendarBeforeIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_INVALID_STATE and @c E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid. + * + * @section CompCalendarBeforeSolutionSection Resolutions + * 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 any time field value previously set is invalid. - * -# The method returns E_OUT_OF_RANGE if the value of the time fields goes out of range. - * @endif - */ + * -# The method returns @c E_INVALID_ARG if the instance of %Calendar to be compared is invalid. + * -# The method returns @c E_INVALID_STATE if any time field value previously set is invalid. + * -# The method returns @c E_OUT_OF_RANGE if the value of the time fields goes out of range. + * @endif + */ /** * Clears all the time fields and sets it to @c 0. @n - * Zero is not the default value for each field. It means the field is cleared. + * Zero is not the default value for each field. It means that the field is cleared. * * @since 2.0 * @@ -271,7 +271,7 @@ public: /** * Clears the specified time field and sets it to @c 0. @n - * Zero is not the default value for each field. It means the field is cleared. + * Zero is not the default value for each field. It means that the field is cleared. * * @since 2.0 * @@ -288,7 +288,7 @@ public: * * @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance of %Calendar, @n * else @c false - * @param[in] obj An instance of Tizen::Base::Object to compare + * @param[in] obj An instance of Tizen::Base::Object to compare */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -302,43 +302,45 @@ public: virtual int GetHashCode(void) const; /** - * Rolls up or down as per the specified @c amount in the specified time field without changing the larger fields (for example, TIME_FIELD_YEAR field cannot be changed when the input field is TIME_FIELD_MONTH). @n + * Rolls up or down as per the specified @c amount in the specified time field without changing the larger fields + * (for example, @c TIME_FIELD_YEAR field cannot be changed when the input field is @c TIME_FIELD_MONTH). @n * If the specified @c amount is negative, the amount value is deducted from the specified time field value. - * In this method, the time field of this instance is operated upon. If the value of the specified @c field goes out of range, E_OUT_OF_RANGE is returned. + * In this method, the time field of this instance is operated upon. If the value of the specified @c field goes out of range, + * @c E_OUT_OF_RANGE is returned. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarRollPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarRollPage "here". * @endif * * @return An error code - * @param[in] field The time field to roll - * @param[in] amount The amount to add to the time field - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET). - * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @param[in] field The time field to roll + * @param[in] amount The amount to add to the time field + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET). + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields goes out of range, this exception is returned. */ virtual result Roll(TimeField field, int amount); /** * @if OSPCOMPAT - * @page CompCalendarRollPage Compatibility for Roll() - * @section CompCalendarRollIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_INVALID_STATE if the time field is invalid. - * - * @section CompCalendarRollSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompCalendarRollPage Compatibility for Roll() + * @section CompCalendarRollIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_INVALID_STATE if the time field is invalid. + * + * @section CompCalendarRollSolutionSection Resolutions + * 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 @c E_INVALID_ARG if the time field is invalid. * @endif - */ + */ /** * Sets the specified time field with the specified @c value. @n @@ -347,13 +349,13 @@ public: * until GetTimeField(), GetTime(), or GetTimeInMillisec() is called. * Thus, even if you call this method several times, unnecessary multiple computations are not triggered. @n * - * As a result of changing a field using SetTimeField(), other fields may also change + * When a field is changed using SetTimeField(), other fields may also change * depending on the field, the field value, and the calendar system. @n * * For example, consider a GregorianCalendar set to Oct. 31, 2004. - * Calling SetTimeField(TIME_FIELD_MONTH, NOVEMBER) sets the calendar to Nov 31, 2004. @n + * Calling SetTimeField(@c TIME_FIELD_MONTH, NOVEMBER) sets the calendar to Nov 31, 2004. @n * But, if you call GetTime(), then Dec 1, 2004 is returned because Nov 31, 2004 does not exist. - * However, a call to SetTimeField(TIME_FIELD_MONTH, SEPTEMBER) before a call to GetTime() sets the calendar + * However, a call to SetTimeField(@c TIME_FIELD_MONTH, SEPTEMBER) before a call to GetTime() sets the calendar * to Sep 30, 2004, since no re-computation has occurred after the first call to SetTimeField(). * * The value of field is not affected by it being local time or UTC time. @@ -407,25 +409,25 @@ public: /** * Sets the value of year, month, day, hour, minute, and seconds. @n - * The date and time are local time. + * The date and time are the local date and time. * * @since 2.0 * * @return An error code - * @param[in] year The value to set for year - * @param[in] month The value to set for month @n + * @param[in] year The year to set + * @param[in] month The month to set @n * The indexing is 1-based. Therefore, 1 means January. - * @param[in] day The value to set for day - * @param[in] hour The value to set for hour - * @param[in] minute The value to set for minute - * @param[in] second The value to set for second + * @param[in] day The day to set + * @param[in] hour The hour to set + * @param[in] minute The minute to set + * @param[in] second The second to set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE A time field or its value is out of range in lenient mode. + * @exception E_OUT_OF_RANGE A time field or its value is out of range in lenient mode. */ result SetTime(int year, int month, int day, int hour = 0, int minute = 0, int second = 0); /** - * Sets the calendar's current time with the specified Tizen::Base::DateTime. + * Sets the current time of this %Calendar instance with the specified Tizen::Base::DateTime. * * @since 2.0 * @@ -461,30 +463,29 @@ public: /** * Gets the actual maximum value that the specified field can have, given the current date. @n - * For example, if the current date is "Feb 10, 2004" and the time field specified is TIME_FIELD_DAY_OF_MONTH, then the actual - * maximum value for this time field is 29. + * For example, if the current date is "Feb 10, 2004" and the time field specified is @c TIME_FIELD_DAY_OF_MONTH, then the actual + * maximum value for this time field is @c 29. * * @since 2.0 * * @return An integer value indicating the actual maximum value - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual int GetActualMaxTimeField(TimeField field) const; /** * Gets the actual minimum value that the specified time field can have, given the current date. @n - * For the Gregorian calendar, this is the same as GetMinTimeField() and - * GetGreatestMinTimeField(). + * For the Gregorian calendar, this is the same as GetMinTimeField() and GetGreatestMinTimeField(). * * @since 2.0 * * @return An integer value indicating the actual minimum value - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -492,12 +493,12 @@ public: /** * Gets the value of the first day of the week. @n - * For example, in USA, the first day of the week is SUNDAY. But, it is MONDAY in France. + * For example, in USA, the first day of the week is SUNDAY. But, in France, it is MONDAY. * - * @since 2.0 + * @since 2.0 * - * @return An integer value indicating the first day of the week, @n - * else @c -1 if the method fails + * @return An integer value indicating the first day of the week, @n + * else @c -1 if it fails */ int GetFirstDayOfWeek(void) const; @@ -507,9 +508,9 @@ public: * @since 2.0 * * @return An integer value indicating the greatest minimum value for the specified time field - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -521,9 +522,9 @@ public: * @since 2.0 * * @return An integer value indicating the least maximum value for the specified time field - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -535,9 +536,9 @@ public: * @since 2.0 * * @return An integer value indicating the maximum value for the specified time field - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -549,9 +550,9 @@ public: * @since 2.0 * * @return An integer value indicating the minimum value for the specified time field - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -574,7 +575,7 @@ public: * @since 2.0 * * @return An instance of Tizen::Base::DateTime with the current time in local time - * @remarks The time specified is local time. + * @remarks The time specified is the local time. */ Tizen::Base::DateTime GetTime(void) const; @@ -585,13 +586,14 @@ public: * * @return An integer value indicating the value of the specified time field * - * @param[in] field The given time field + * @param[in] field The given time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. - * @remarks This method is semantically const, but may alter the instance in memory. - * All fields are re-computed if any field is invalid. - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method is semantically const, but may alter the instance in memory. + * - All fields are re-computed if any field is invalid. + * - The specific error code can be accessed using the GetLastResult() method. */ int GetTimeField(TimeField field) const; @@ -601,11 +603,11 @@ public: * @since 2.0 * * @return An error code - * @param[out] millisec The current time in milliseconds from starting day (Jan 1, 1.) - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_OUT_OF_RANGE The value of the argument is out of the valid range defined by the method. + * @param[out] millisec The current time in milliseconds from starting day (Jan 1, 1.) + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. + * @exception E_OUT_OF_RANGE The value of the argument is out of the valid range defined by the method. */ result GetTimeInMillisec(long long& millisec) const; @@ -615,7 +617,8 @@ public: * @since 2.0 * * @return The TimeZone instance associated with the current instance of %Calendar - * @remarks The returned reference is valid only until the SetTimeZone() method is called or this instance of %Calendar is destroyed. + * @remarks The returned reference is valid only until the SetTimeZone() method is called or + * this instance of %Calendar is destroyed. * @see SetTimeZone() */ TimeZone GetTimeZone(void) const; @@ -626,7 +629,7 @@ public: * @since 2.0 * * @return An instance of CalendarType representing the calendar type of the current instance of %Calendar @n - * For example, CALENDAR_GREGORIAN. + * For example, @c CALENDAR_GREGORIAN. */ virtual CalendarType GetType(void) const = 0; @@ -636,13 +639,14 @@ public: * @since 2.0 * * @return An error code - * @param[out] isInDst Set to @c true if the current date is in DST, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n - * In this method, the time fields of this instance are calculated. If the value of the time fields goes out of range, this exception is returned. + * @param[out] isInDst Set to @c true if the current date is in DST, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. + * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n + * In this method, the time fields of this instance are calculated. + * If the value of the time fields goes out of range, this exception is returned. */ virtual result IsInDst(bool& isInDst) const = 0; @@ -669,15 +673,15 @@ public: /** * Creates an instance of %Calendar of the specified type with the GMT time zone and the system locale. @n - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. * * @since 2.0 * * @return A pointer to the created %Calendar instance, @n - * else @c null if the method fails + * else @c null if it fails * @param[in] calendarType The type of calendar @n - * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN). + * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN). * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -688,16 +692,16 @@ public: /** * Creates an instance of %Calendar of the specified type with the specified time zone and the system locale. @n * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. * * @since 2.0 * * @return A pointer to the created %Calendar instance, @n - * else @c null if the method fails + * else @c null if it fails * @param[in] timeZone An instance of TimeZone * @param[in] calendarType The type of calendar @n - * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN). + * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN). * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -707,27 +711,27 @@ public: /** * Creates an instance of %Calendar of the specified type with the specified @c locale and the GMT time zone. @n - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarCreateInstanceNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarCreateInstanceNPage "here". * @endif * * @return A pointer to the created %Calendar instance, @n - * else @c null if the method fails + * else @c null if it fails * @param[in] locale The locale for whose country the %Calendar instance is needed * @param[in] calendarType The type of calendar @n - * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN). + * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN). * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Calendar* CreateInstanceN(const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN); @@ -735,52 +739,52 @@ public: /** * Creates an instance of %Calendar of the specified type with the specified time zone and @c locale. @n * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarCreateInstanceNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarCreateInstanceNPage "here". * @endif * * @return A pointer to the created %Calendar instance, @n - * else @c null if the method fails + * else @c null if it fails * @param[in] timeZone An instance of TimeZone - * @param[in] locale The locale for whose country the %Calendar instance is needed - * @param[in] calendarType The type of calendar @n - * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN). + * @param[in] locale The locale for the country the %Calendar instance is created + * @param[in] calendarType The calendar type @n + * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN). * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Calendar* CreateInstanceN(const TimeZone& timeZone, const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN); /** * @if OSPCOMPAT - * @page CompCalendarCreateInstanceNPage Compatibility for CreateInstanceN() - * @section CompCalendarCreateInstanceNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the locale is invalid. - * - * @section CompCalendarCreateInstanceNSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the locale is invalid. + * @page CompCalendarCreateInstanceNPage Compatibility for CreateInstanceN() + * @section CompCalendarCreateInstanceNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the locale is invalid. + * + * @section CompCalendarCreateInstanceNSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns @c E_INVALID_ARG if the locale is invalid. * @endif - */ + */ protected: /** * @enum AmPm * * Defines the AM/PM mode. @n - * This is a.m./p.m. The indexing is 0-based. + * The indexing is 0-based. * * @since 2.0 */ @@ -793,7 +797,7 @@ protected: /** * @enum CalendarLimitType * - * Defines the calendar limitations. + * Defines the calendar limits. * * @since 2.0 */ @@ -815,99 +819,97 @@ protected: */ enum StampValue { - UNSET = 0, /**< Unset */ - COMPUTED, /**< Computed */ - MINIMUM_USER_STAMP /**< Minimum user stamp */ + UNSET = 0, /**< The stamp is unset */ + COMPUTED, /**< The stamp is computed */ + MINIMUM_USER_STAMP /**< The minimum user stamp */ }; /** - * This is the default constructor for this class. @n - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. - * - * @since 2.0 - * - * @see Construct() - */ + * This is the default constructor for this class. @n + * The object is not fully constructed after this constructor is called. For full construction, + * the Construct() method must be called right after calling this constructor. + * + * @since 2.0 + */ Calendar(void); /** - * Initializes this instance of %Calendar. - * - * @since 2.0 - * - * @return An error code - * @exception E_SUCCESS The method is successful. - */ + * Initializes this instance of %Calendar. + * + * @since 2.0 + * + * @return An error code + * @exception E_SUCCESS The method is successful. + */ result Construct(void); /** - * Initializes this instance of %Calendar with the specified parameter. - * - * @since 2.0 - * - * @return An error code - * @param[in] calendar The %Calendar instance to copy - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * - */ + * Initializes this instance of %Calendar with the specified %Calendar instance. + * + * @since 2.0 + * + * @return An error code + * @param[in] calendar The %Calendar instance to copy + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * + */ result Construct(const Calendar& calendar); /** - * Initializes this instance of %Calendar with the specified time zone and @c locale. @n - * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. - * - * @if OSPCOMPAT - * @brief [Compatibility] - * @endif - * @since 2.0 - * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarConstructPage "here". - * @endif - * - * @return An error code - * @param[in] timeZone An instance of TimeZone - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c locale is invalid. - */ + * Initializes this instance of %Calendar with the specified time zone and @c locale. @n + * The @c timeZone is used for the zone offset and the DST offset. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. + * + * @if OSPCOMPAT + * @brief [Compatibility] + * @endif + * @since 2.0 + * @if OSPCOMPAT + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarConstructPage "here". + * @endif + * + * @return An error code + * @param[in] timeZone An instance of TimeZone + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c locale is invalid. + */ result Construct(const Tizen::Locales::TimeZone& timeZone, const Locale& locale); /** - * @if OSPCOMPAT - * @page CompCalendarConstructPage Compatibility for Construct() - * @section CompCalendarConstructIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the locale is invalid. - * - * @section CompCalendarConstructSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the locale is invalid. - * @endif - */ + * @if OSPCOMPAT + * @page CompCalendarConstructPage Compatibility for Construct() + * @section CompCalendarConstructIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the locale is invalid. + * + * @section CompCalendarConstructSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns @c E_INVALID_ARG if the locale is invalid. + * @endif + */ /** - * Rolls up or down with a single unit of time on a given time field without changing larger fields. @n - * When rolling on the MONTH field, other fields such as DATE field might conflict - * and needs to be changed. + * Rolls up or down with a single unit of time on the specified time field without changing the larger fields. @n + * When rolling on the MONTH field, other fields such as DATE field might conflict and need to be changed. * * @since 2.0 * * @return An error code - * @param[in] field The time field to change - * @param[in] up Set to @c true if the time field must be rolled upwards, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET). - * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n - * In this method, the time fields of this instance are calculated. - * If the value of the time fields goes out of range, this exception is returned. + * @param[in] field The time field to change + * @param[in] up Set to @c true if the time field must be rolled upwards, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. + * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET). + * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n + * In this method, the time fields of this instance are calculated. + * If the value of the time fields goes out of range, this exception is returned. */ virtual result RollWithSingleUnit(TimeField field, bool up) = 0; @@ -918,7 +920,7 @@ protected: * * @return @c true if the current instance of %Calendar is equivalent to the specified %Calendar instance, @n * else @c false - * @param[in] calendar The instance of %Calendar to compare with + * @param[in] calendar The instance of %Calendar to compare * @remarks If the specified %Calendar instance is equivalent to the current instance, the two instances behave * exactly the same, but they may be set to different times. */ @@ -927,14 +929,15 @@ protected: /** * Computes the time field value. @n * Converts the current millisecond time value to TimeField. @n - * This allows synching up the time field values with a new time that is set for the calendar. + * This allows syncing up the time field values with a new time that is set for the calendar. * * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The time fields contain an invalid value. @n - * In this method, the time fields of this instance are calculated. If the value of the time fields goes out of range, this exception is returned. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_RANGE The time fields contain an invalid value. @n + * In this method, the time fields of this instance are calculated. + * If the value of the time fields goes out of range, this exception is returned. */ virtual result ComputeTimeFields(void) = 0; @@ -962,11 +965,11 @@ protected: virtual int GetMonthLength(int extendedYear, int month) const = 0; /** - * Handles the limits of different types. @n + * Handle the limits of the specified time field that depend on the type of limit. @n * Derived classes must implement this method for the following fields: - * TIME_FIELD_ERA, TIME_FIELD_YEAR, TIME_FIELD_MONTH, TIME_FIELD_WEEK_OF_YEAR, TIME_FIELD_WEEK_OF_MONTH, - * TIME_FIELD_DAY_OF_MONTH, TIME_FIELD_DAY_OF_YEAR, TIME_FIELD_DAY_OF_WEEK_IN_MONTH, TIME_FIELD_YEAR_WOY, - * TIME_FIELD_EXTENDED_YEAR. + * @c TIME_FIELD_ERA, @c TIME_FIELD_YEAR, @c TIME_FIELD_MONTH, @c TIME_FIELD_WEEK_OF_YEAR, @c TIME_FIELD_WEEK_OF_MONTH, + * @c TIME_FIELD_DAY_OF_MONTH, @c TIME_FIELD_DAY_OF_YEAR, @c TIME_FIELD_DAY_OF_WEEK_IN_MONTH, @c TIME_FIELD_YEAR_WOY, + * @c TIME_FIELD_EXTENDED_YEAR. * * @since 2.0 * @@ -976,7 +979,7 @@ protected: */ virtual int HandleGetLimit(TimeField field, CalendarLimitType limitType) const = 0; - /* + /** * Creates and returns a polymorphic copy of this calendar. * * @since 2.0 @@ -1050,35 +1053,35 @@ private: public: /** - * Millisecond constants for one day. + * One day in milliseconds. * * @since 2.0 */ static const int ONE_DAY_IN_MILLISEC = 86400000; /** - * Millisecond constants for one hour. + * One hour in milliseconds. * * @since 2.0 */ static const int ONE_HOUR_IN_MILLISEC = 60 * 60 * 1000; /** - * Millisecond constants for one minute. + * One minute in milliseconds. * * @since 2.0 */ static const int ONE_MINUTE_IN_MILLISEC = 60000; /** - * Millisecond constants for one second. + * One second in milliseconds. * * @since 2.0 */ static const int ONE_SECOND_IN_MILLISEC = 1000; /** - * Millisecond constants for one week. + * One week in milliseconds. * * @since 2.0 */ diff --git a/inc/FLclCurrency.h b/inc/FLclCurrency.h index ecb1466..200fb40 100644 --- a/inc/FLclCurrency.h +++ b/inc/FLclCurrency.h @@ -35,7 +35,7 @@ class Locale; /** * @class Currency - * @brief This class represents currencies. + * @brief This class provides methods for currencies. * * @since 2.0 * @@ -54,11 +54,10 @@ public: /** * This is the default constructor for this class. @n - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, the Construct() method + * must be called right after calling this constructor. * * @since 2.0 - * - * @see Construct() */ Currency(void); @@ -80,13 +79,13 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCurrencyConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCurrencyConstructPage "here". * @endif * * @return An error code - * @param[in] locale The specified @c locale to get the currency symbol - * @exception E_SUCCESS The method is successful. + * @param[in] locale The specified @c locale to get the currency symbol + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c locale is not supported. */ result Construct(const Locale& locale); @@ -94,37 +93,38 @@ public: /** * Initializes this instance of %Currency with the specified currency code. @n - * Currencies are enumerated as defined by ISO 4217. For example, if the locale is Korean (language) and Korea (country), the currency code is "KRW". + * The currencies are enumerated as defined by ISO 4217. For example, if the locale is Korean (language) and Korea (country), + * the currency code is "KRW". * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCurrencyConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCurrencyConstructPage "here". * @endif * * @return An error code - * @param[in] currencyCode The specified currency code to get the currency symbol - * @exception E_SUCCESS The method is successful. + * @param[in] currencyCode The specified currency code to get the currency symbol + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c currencyCode is not supported. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. */ result Construct(const Tizen::Base::String& currencyCode); /** * @if OSPCOMPAT - * @page CompCurrencyConstructPage Compatibility for Construct() - * @section CompCurrencyConstructIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid. - * - * @section CompCurrencyConstructSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompCurrencyConstructPage Compatibility for Construct() + * @section CompCurrencyConstructIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid. + * + * @section CompCurrencyConstructSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the argument is invalid. + * -# The method returns E_INVALID_ARG if the argument is invalid. * @endif - */ + */ /** @@ -158,7 +158,7 @@ public: * * @return @c true if the value of the specified instance is equal to that of the current instance, @n * else @c false - * @param[in] obj The object to compare with the current instance + * @param[in] obj The object to compare with the current instance */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -180,7 +180,7 @@ public: * else a @c null pointer is returned if there is no currency available or there is some failure @n * The array is a list of all the available currencies. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::Collection::IList* GetAvailableCurrenciesN(void); diff --git a/inc/FLclDateTimeFormatter.h b/inc/FLclDateTimeFormatter.h index e965050..101e77b 100644 --- a/inc/FLclDateTimeFormatter.h +++ b/inc/FLclDateTimeFormatter.h @@ -48,12 +48,12 @@ class _DateTimeFormatterImpl; */ enum DateTimeStyle { - DATE_TIME_STYLE_NONE = -1, /**< The date time style: None */ - DATE_TIME_STYLE_FULL = 0, /**< The date time style: FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42PM PST */ - DATE_TIME_STYLE_LONG = 1, /**< The date time style: LONG is longer, such as July 18, 2012 or 3:30:32PM */ - DATE_TIME_STYLE_MEDIUM = 2, /**< The date time style: MEDIUM is a little longer, such as Jan 12, 1952 */ - DATE_TIME_STYLE_SHORT = 3, /**< The date time style: SHORT is completely numeric, such as 12/13/52 or 3:30PM */ - DATE_TIME_STYLE_DEFAULT = DATE_TIME_STYLE_MEDIUM /**< The default date time style: Medium */ + DATE_TIME_STYLE_NONE = -1, /**< No date time style */ + DATE_TIME_STYLE_FULL = 0, /**< The full date time style @n For example, Tuesday, April 12, 1952 AD or 3:30:42PM PST */ + DATE_TIME_STYLE_LONG = 1, /**< The long date time style @n For example, July 18, 2012 or 3:30:32PM */ + DATE_TIME_STYLE_MEDIUM = 2, /**< The medium date time style @n For example, Jan 12, 1952 */ + DATE_TIME_STYLE_SHORT = 3, /**< The short date time style @n This style is completely numeric. For example, 12/13/52 or 3:30PM */ + DATE_TIME_STYLE_DEFAULT = DATE_TIME_STYLE_MEDIUM /**< The default date time style @n This is set to Medium */ }; /** @@ -138,11 +138,11 @@ public: * @return A pointer to the system locale date formatter, @n * else @c null if an error occurs * @param[in] style The formatting style @n - * For example, "M/d/yy" is the short form for displaying only date in the US locale. + * For example, "M/d/yy" is the short form for displaying only the date in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_OPERATION The current locale is not supported. - * @exception E_INVALID_ARG The specified @c style is an invalid value. + * @exception E_INVALID_ARG The specified @c style is an invalid value. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateDateFormatterN(DateTimeStyle style = DATE_TIME_STYLE_DEFAULT); @@ -152,39 +152,39 @@ public: * Creates the date formatter with the specified formatting style for the specified locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here". * @endif * * @return A pointer to the specified locale date formatter, @n * else @c null if an error occurs * @param[in] locale The locale * @param[in] style The formatting style @n - * For example, "M/d/yy" is the short form for displaying only date in the US locale. + * For example, "M/d/yy" is the short form for displaying only the date in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale or @c style is invalid. + * @exception E_INVALID_ARG The specified @c locale or @c style is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateDateFormatterN(const Locale& locale, DateTimeStyle style = DATE_TIME_STYLE_DEFAULT); /** * @if OSPCOMPAT - * @page CompDateTimeFormatterCreateDateFormatterNPage Compatibility for CreateDateFormatterN() - * @section CompDateTimeFormatterCreateDateFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompDateTimeFormatterCreateDateFormatterNtSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompDateTimeFormatterCreateDateFormatterNPage Compatibility for CreateDateFormatterN() + * @section CompDateTimeFormatterCreateDateFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompDateTimeFormatterCreateDateFormatterNtSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid. + * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid. * @endif - */ + */ /** @@ -199,7 +199,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_OPERATION The current locale is not supported. - * @exception E_INVALID_ARG The specified @c style is invalid. + * @exception E_INVALID_ARG The specified @c style is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateTimeFormatterN(DateTimeStyle style = DATE_TIME_STYLE_DEFAULT); @@ -209,12 +209,12 @@ public: * Creates the time formatter with the specified formatting style for the specified @c locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here". * @endif * * @return A pointer to the specified locale time formatter, @n @@ -224,24 +224,24 @@ public: * For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale or @c style is invalid. + * @exception E_INVALID_ARG The specified @c locale or @c style is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateTimeFormatterN(const Locale& locale, DateTimeStyle style = DATE_TIME_STYLE_DEFAULT); /** * @if OSPCOMPAT - * @page CompDateTimeFormatterCreateTimeFormatterNPage Compatibility for CreateTimeFormatterN() - * @section CompDateTimeFormatterCreateTimeFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompGrDateTimeFormatterCreateTimeFormatterNSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid. + * @page CompDateTimeFormatterCreateTimeFormatterNPage Compatibility for CreateTimeFormatterN() + * @section CompDateTimeFormatterCreateTimeFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompGrDateTimeFormatterCreateTimeFormatterNSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid. * @endif - */ + */ /** * Creates the date/time formatter with the specified formatting style for the system locale. @@ -251,13 +251,13 @@ public: * @return A pointer to the system locale date/time formatter, @n * else @c null if an error occurs * @param[in] dateStyle The date formatting style @n - * For example, "M/d/yy" is the short form for displaying only date in the US locale. + * For example, "M/d/yy" is the short form for displaying only the date in the US locale. * @param[in] timeStyle The time formatting style @n * For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_OPERATION The current locale is not supported. - * @exception E_INVALID_ARG The specified @c dateStyle or @c timeStyle is invalid. + * @exception E_INVALID_ARG The specified @c dateStyle or @c timeStyle is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateDateTimeFormatterN(DateTimeStyle dateStyle = DATE_TIME_STYLE_DEFAULT, DateTimeStyle timeStyle = DATE_TIME_STYLE_DEFAULT); @@ -277,22 +277,21 @@ public: * For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is not supported, or the @c dateStyle or the @c timeStyle is invalid. + * @exception E_INVALID_ARG The specified @c locale is not supported, or the @c dateStyle or the @c timeStyle is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateDateTimeFormatterN(const Locale& locale, DateTimeStyle dateStyle = DATE_TIME_STYLE_DEFAULT, DateTimeStyle timeStyle = DATE_TIME_STYLE_DEFAULT); /** - * Formats a Tizen::Base::DateTime object into a date/time string and appends the resulting string to the specified string buffer. + * Formats a Tizen::Base::DateTime object into a date/time string and appends the resulting string to the specified string. * * @since 2.0 * * @return An error code * @param[in] date The Tizen::Base::DateTime object to format - * @param[out] str The string to append to the resultant string + * @param[out] str The string to which formatted string is appended * @exception E_SUCCESS The method is successful. * @remarks This method does not handle the time zone information, so "z" pattern always returns "GMT+00:00". - * @see Tizen::Base::DateTime */ virtual result Format(const Tizen::Base::DateTime& date, Tizen::Base::String& str) const; @@ -304,9 +303,9 @@ public: * * @return An error code * @param[in] calendar The Calendar object to format - * @param[out] str The string to append to the resultant string + * @param[out] str The string to which formatted string is appended * @exception E_SUCCESS The method is successful. - * @see Tizen::Base::DateTime + * @see Tizen::Base::DateTime */ virtual result Format(const Calendar& calendar, Tizen::Base::String& str) const; @@ -316,7 +315,7 @@ public: * * @since 2.0 * - * @param[in] pattern The new date and time pattern for the date format + * @param[in] pattern The date and time pattern for the date format * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The length of the specified @c pattern is @c 0. */ @@ -324,11 +323,11 @@ public: /** - * Gets a pattern string describing the date format. + * Gets the pattern string describing the date format. * * @since 2.0 * - * @return A string describing the date format + * @return The date format pattern string */ Tizen::Base::String GetPattern(void) const; @@ -338,18 +337,18 @@ public: * * @since 2.0 * - * @return A pointer to DateTimeSymbols for the formatter instance + * @return A pointer to DateTimeSymbols of the formatter * @see SetDateTimeSymbols() */ const DateTimeSymbols* GetDateTimeSymbols(void) const; /** - * Sets the date and time format symbols of the date format. + * Sets the date and time format symbols of the formatter. * * @since 2.0 * - * @param[in] newSymbols The new date and time format symbols + * @param[in] newSymbols The date and time format symbols * @see GetDateTimeSymbols() */ void SetDateTimeSymbols(const DateTimeSymbols& newSymbols); diff --git a/inc/FLclDateTimeSymbols.h b/inc/FLclDateTimeSymbols.h index e89cd81..f3f1abb 100644 --- a/inc/FLclDateTimeSymbols.h +++ b/inc/FLclDateTimeSymbols.h @@ -33,13 +33,14 @@ namespace Tizen { namespace Locales /** * @class DateTimeSymbols - * @brief This class provides methods that help in providing date and time symbols. + * @brief This class provides methods for date and time symbols. * * @since 2.0 * - * The %DateTimeSymbols class is used for encapsulating localizable date-time formatting data, such as the names of the months, the days of the week, and the time zone data. - * It is also used by DateTimeFormatter. - * %DateTimeSymbols specifies the exact character strings to use for various parts of a date or time. For example, the names of the months and days of the week, the strings for AM and PM, and the day of the week considered to be the first day of the week. + * The %DateTimeSymbols class is used for encapsulating localizable date-time formatting data, such as the names of the months, + * the days of the week, and the time zone data. It is also used by DateTimeFormatter. + * %DateTimeSymbols specifies the exact character strings to use for various parts of a date or time. For example, the names of + * the months and days of the week, the strings for AM and PM, and the day of the week considered to be the first day of the week. * * For more information on the class features, see Date and Time Formatter. * @@ -53,11 +54,10 @@ class _OSP_EXPORT_ DateTimeSymbols public: /** * This is the default constructor for this class. @n - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, the Construct() method + * must be called right after calling this constructor. * * @since 2.0 - * - * @see Construct() */ DateTimeSymbols(void); @@ -74,12 +74,12 @@ public: * Initializes this instance of %DateTimeSymbols with the specified @c locale and @c calendarType. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompDateTimeSymbolsConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompDateTimeSymbolsConstructPage "here". * @endif * * @return An error code @@ -87,7 +87,7 @@ public: * @param[in] calendarType The calendar type * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale or @c calendarType is invalid. + * @exception E_INVALID_ARG The specified @c locale or @c calendarType is invalid. */ result Construct(const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN); @@ -101,31 +101,31 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompDateTimeSymbolsConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompDateTimeSymbolsConstructPage "here". * @endif * * @return An error code * @param[in] calendarType The calendar type * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c calendarType is invalid. + * @exception E_INVALID_ARG The specified @c calendarType is invalid. */ result Construct(CalendarType calendarType); /** * @if OSPCOMPAT - * @page CompDateTimeSymbolsConstructPage Compatibility for Construct() - * @section CompDateTimeSymbolsConstructIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c calendarType is invalid. - * - * @section CompDateTimeSymbolsConstructSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c calendarType is invalid. + * @page CompDateTimeSymbolsConstructPage Compatibility for Construct() + * @section CompDateTimeSymbolsConstructIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns E_UNSUPPORTED_OPERATION if the @c calendarType is invalid. + * + * @section CompDateTimeSymbolsConstructSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns E_INVALID_ARG if the @c calendarType is invalid. * @endif - */ + */ /** @@ -156,12 +156,12 @@ public: /** * Sets the era strings. @n - * Multiple strings can be concatenated by '|'. For example: "AD|BC". + * Multiple strings can be concatenated using '|'. For example: "AD|BC". * * @since 2.0 * * @return An error code - * @param[in] eras The era strings concatenated by '|' + * @param[in] eras The era strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c eras contains an invalid value. * @see GetEras() @@ -171,7 +171,7 @@ public: /** * Gets the list of the month name strings. @n - * For example: "January", "February", etc. + * For example: "January", "February". * * @since 2.0 * @@ -183,13 +183,13 @@ public: /** - * Sets the month name strings concatenated by '|'. @n + * Sets the month name strings concatenated using '|'. @n * For example: "January|February|March|April|May|June|July|August|September|October|November|December". * * @since 2.0 * * @return An error code - * @param[in] months The new month strings concatenated by '|' + * @param[in] months The month strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c months contains an invalid value. * @see GetMonths() @@ -199,7 +199,7 @@ public: /** * Gets the list of the short month name strings. @n - * For example: "Jan", "Feb", etc. + * For example: "Jan", "Feb". * * @since 2.0 * @@ -211,22 +211,23 @@ public: /** - * Sets the short month name strings concatenated by '|'. @n + * Sets the short month name strings concatenated using '|'. @n * For example: "Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec". * - * @since 2.0 + * @since 2.0 * @return An error code - * @param[in] shortMonths The new short month name strings concatenated by '|' + * @param[in] shortMonths The short month name strings concatenated using '|' * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c shortMonths contains an invalid value. @n See the valid string in the description of the method. - * @see GetShortMonths() + * @exception E_INVALID_ARG The specified @c shortMonths contains an invalid value. @n + * See the valid string in the description of the method. + * @see GetShortMonths() */ result SetShortMonths(const Tizen::Base::String& shortMonths); /** * Gets the list of the weekday name strings. @n - * For example: "Sunday", "Monday", etc. + * For example: "Sunday", "Monday". * * @since 2.0 * @@ -244,7 +245,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] weekdays The new weekday name strings concatenated by '|' + * @param[in] weekdays The weekday name strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c weekdays contains an invalid value. * @see GetWeekdays() @@ -254,7 +255,7 @@ public: /** * Gets the list of the short weekday name strings. @n - * For example: "Sun", "Mon", etc. + * For example: "Sun", "Mon". * * @since 2.0 * @@ -266,13 +267,13 @@ public: /** - * Sets the weekday name strings concatenated by '|'. @n + * Sets the weekday name strings concatenated using '|'. @n * For example: "Sun|Mon|Tue|Wed|Thu|Fri|Sat". * * @since 2.0 * * @return An error code - * @param[in] shortWeekdays The new short weekday strings concatenated by '|' + * @param[in] shortWeekdays The short weekday strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c shortWeekdays contains an invalid value. * @see GetShortWeekdays() @@ -294,13 +295,13 @@ public: /** - * Sets the AM/PM strings concatenated by '|'. @n + * Sets the AM/PM strings concatenated using '|'. @n * For example: "AM|PM". * * @since 2.0 * * @return An error code - * @param[in] amPm The new AM/PM strings concatenated by '|' + * @param[in] amPm The AM/PM strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c amPm contains an invalid value. * @see GetAmPm() @@ -312,11 +313,11 @@ public: * Gets the name of the time zone. @n * For example: "Eastern European Time (EET)", "Eastern European Summer Time (EEST)". * - * @since 2.0 + * @since 2.0 * - * @return The time zone name, @n - * else an empty string if @c timeZoneId is not found @n - * or the time zone name of @c timeZoneStyle is not found. + * @return The time zone name, @n + * else an empty string if @c timeZoneId is not found @n + * or the time zone name of @c timeZoneStyle is not found. * @param[in] timeZoneId The time zone ID * @param[in] timeZoneStyle The parameter may contain one of the following time zone styles: * @li The normal time zone (0) @@ -337,19 +338,19 @@ public: * @return An error code * @param[in] timeZoneId The time zone ID @n * For example: "Europe/Helsinki". - * @param[in] concatenatedTimeZoneName The new concatenated time zone name @n + * @param[in] concatenatedTimeZoneName The concatenated time zone name @n * For example, "Eastern European Time|EET|Eastern European Summer Time|EEST". * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c timeZoneId or @c concatenatedTimeZoneName contains an invalid value. * @exception E_OBJ_NOT_FOUND The specified @c timeZoneId is not found. - * @see GetTimeZoneName() - * @see AddTimeZoneName() + * @see GetTimeZoneName() + * @see AddTimeZoneName() */ result SetTimeZoneName(const Tizen::Base::String& timeZoneId, const Tizen::Base::String& concatenatedTimeZoneName); /** - * Adds a new time zone name string that is related to time zone ID. + * Adds the time zone name that is related to time zone ID. * * @since 2.0 * diff --git a/inc/FLclGregorianCalendar.h b/inc/FLclGregorianCalendar.h index eabbaa9..a249a4d 100644 --- a/inc/FLclGregorianCalendar.h +++ b/inc/FLclGregorianCalendar.h @@ -34,11 +34,12 @@ namespace Tizen { namespace Locales /** * @class GregorianCalendar - * @brief This class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used standard calendar. + * @brief This class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used + * standard calendar. * * @since 2.0 * - * @final This class is not intended for extension. + * @final This class is not intended for extension. * * The %GregorianCalendar class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used standard calendar. * @@ -84,11 +85,10 @@ class _OSP_EXPORT_ GregorianCalendar public: /** * This is the default constructor for this class. @n - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must + * be called right after calling this constructor. * * @since 2.0 - * - * @see Construct() */ GregorianCalendar(void); @@ -103,17 +103,17 @@ public: /** - * Initializes this instance of %GregorianCalendar with the current GMT time zone and the system locale. - * The time zone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set and weekend cease. - * The weekdata are set as default values by the locale. - * - * @since 2.0 - * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - */ + * Initializes this instance of %GregorianCalendar with the current GMT time zone and the system locale. @n + * The time zone is used for the zone offset and the DST offset. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set and weekend cease. + * The weekdata is set to default values by the locale. + * + * @since 2.0 + * + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + */ result Construct(void); @@ -133,8 +133,8 @@ public: /** * Initializes this instance of %GregorianCalendar based on the current time in the specified time zone with the system locale. @n * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. * * @since 2.0 * @@ -149,23 +149,23 @@ public: /** * Initializes this instance of %GregorianCalendar based on the current time in the GMT time zone with the specified @c locale. * The time zone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompGregorianCalendarConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompGregorianCalendarConstructPage "here". * @endif * * @return An error code - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c locale is invalid. */ result Construct(const Locale& locale); @@ -173,16 +173,16 @@ public: /** * Initializes this instance of %GregorianCalendar based on the current time in the specified time zone with the specified system locale. @n * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompGregorianCalendarConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompGregorianCalendarConstructPage "here". * @endif * * @return An error code @@ -190,21 +190,21 @@ public: * @param[in] locale An instance of Locale * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @exception E_INVALID_ARG The specified @c locale is invalid. */ result Construct(const TimeZone& timeZone, const Locale& locale); /** * @if OSPCOMPAT - * @page CompGregorianCalendarConstructPage Compatibility for Construct() - * @section CompGregorianCalendarConstructIssueSection Issues + * @page CompGregorianCalendarConstructPage Compatibility for Construct() + * @section CompGregorianCalendarConstructIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. * - * @section CompGregorianCalendarConstructSolutionSection Resolutions + * @section CompGregorianCalendarConstructSolutionSection Resolutions * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif */ @@ -212,25 +212,25 @@ public: * Initializes this instance of %GregorianCalendar based on the specified @c year, @c month, @c day, @c hour, @c minute, and @c second * in the GMT time zone with the system locale. @n * The time zone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. - * The Gregorian calendar is lenient: time fields are normalized when the user calls the Calendar::GetTimeField() method. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. + * The Gregorian calendar is lenient; time fields are normalized when the user calls the Calendar::GetTimeField() method. * * @since 2.0 * * @return An error code - * @param[in] year An integer value used to set the year time field - * @param[in] month An integer value used to set the month time field @n + * @param[in] year The year value + * @param[in] month The month value @n * The indexing is 1-based. Therefore, 1 means January. - * @param[in] day An integer value used to set the date time field - * @param[in] hour An integer value used to set the hour time field - * @param[in] minute An integer value used to set the minute time field - * @param[in] second An integer value used to set the second time field + * @param[in] day The date value + * @param[in] hour The hour value + * @param[in] minute The minute value + * @param[in] second The second value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An argument is invalid. + * @exception E_INVALID_ARG A specified argument is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. */ result Construct(int year, int month, int day, int hour = 0, int minute = 0, int second = 0); @@ -238,8 +238,8 @@ public: /** * Initializes this instance of %GregorianCalendar based on the specified date and time in the GMT time zone with the system locale. @n * The time zone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. * * @since 2.0 * @@ -247,43 +247,46 @@ public: * @param[in] dateTime An instance of Tizen::Base::DateTime * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c dateTime is invalid. - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @exception E_INVALID_ARG The specified @c dateTime is invalid. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. */ result Construct(const Tizen::Base::DateTime& dateTime); /** * Adds the specified amount to the specified time field, based on the calendar rules. @n - * It is equivalent to calling Set(field, GetTimeField(field)+amount) with two adjustments. @n + * It is equivalent to calling Set(field, GetTimeField(field)+amount) with the following two adjustments: @n * - * @b Add @b Rule1: The value of @c field after the call minus the value of @c field before the call is delta, modulo any overflow that has occurred in @c field. - * Overflow occurs when the @c field value exceeds its range and, as a result, the next larger field is incremented or decremented and the @c field value is adjusted back into its range. @n + * @b Add @b Rule1: The value of @c field after the call minus the value of @c field before the call is delta, modulo any + * overflow that has occurred in @c field. Overflow occurs when the @c field value exceeds its range and, as a result, + * the next larger field is incremented or decremented and the @c field value is adjusted back into its range. @n * - * @b Add @b Rule2: If a smaller field is expected to be invariant, but it is impossible for it to be equal to its prior value because of - * changes in its minimum or maximum value after the @c field value is changed, then its value is adjusted to the closest possible value. @n + * @b Add @b Rule2: If a smaller field is expected to be invariant, but it is impossible for it to be equal to its prior + * value because of changes in its minimum or maximum value after the @c field value is changed, then its value is adjusted + * to the closest possible value. @n * - * A smaller field represents a smaller unit of time. The TIME_FIELD_HOUR field is smaller than the TIME_FIELD_DAY_OF_MONTH field. + * A smaller field represents a smaller unit of time. The @c TIME_FIELD_HOUR field is smaller than the @c TIME_FIELD_DAY_OF_MONTH field. * No adjustment is made to smaller fields that are not expected to be invariant. * The calendar system determines what fields are expected to be invariant. @n * - * In addition, this method forces re-computation of the calendar's milliseconds and all time fields immediately. + * In addition, this method forces re-computation of the calendar's milliseconds and all the time fields immediately. * @n - * For example, consider a %GregorianCalendar set to Oct. 31. 2004. Calling AddTimeField(TIME_FIELD_MONTH, 13) sets the calendar to Nov. 30. 2005. - * The TIME_FIELD_MONTH field is set to TIME_FIELD_NOVEMBER by @b Rule1, since adding 13 months to October gives November of the next year. Since - * the TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2. + * For example, consider a %GregorianCalendar set to Oct. 31. 2004. Calling AddTimeField(@c TIME_FIELD_MONTH, 13) sets the calendar to Nov. 30. 2005. + * The @c TIME_FIELD_MONTH field is set to @c TIME_FIELD_NOVEMBER by @b Rule1, since adding 13 months to October gives the month + * value as November of the next year. Since the @c TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, + * @c TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2. * * @since 2.0 * * @return An error code - * @param[in] field The time field - * @param[in] amount The amount to add - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. - * @remarks The TIME_FIELD_EXTENDED_YEAR and TIME_FIELD_YEAR_WOY fields cannot be added. + * @param[in] field The time field + * @param[in] amount The amount to add + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. + * @remarks The @c TIME_FIELD_EXTENDED_YEAR and @c TIME_FIELD_YEAR_WOY fields cannot be added. */ virtual result AddTimeField(TimeField field, int amount); @@ -295,10 +298,10 @@ public: * @since 2.0 * * @return An integer value indicating the actual minimum value - * @param[in] field The time field - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified time field is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @param[in] field The time field + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified time field is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual int GetActualMinTimeField(TimeField field) const; @@ -310,23 +313,22 @@ public: * @since 2.0 * * @return An integer value indicating the actual maximum value - * @param[in] field The time field - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified time field is invalid. - - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @param[in] field The time field + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified time field is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual int GetActualMaxTimeField(TimeField field) const; - /* + /** * Gets the Gregorian Calendar change date. @n * This is the point when the switch from Julian dates to Gregorian dates occurred. - * Default is 00:00:00 local time, October 15, 1582. Previous to this the time and date are Julian dates. + * Default is 00:00:00 local time, October 15, 1582. Previous to this, the time and date are Julian dates. * * @since 2.0 * - * @return The milliseconds which is the Gregorian cutover time for this calendar + * @return The Gregorian cutover time for this calendar in milliseconds */ long long GetGregorianChange(void) const; @@ -337,7 +339,7 @@ public: * @since 2.0 * * @return An instance of CalendarType representing the calendar type of the current instance of Calendar @n - * In this case, CALENDAR_GREGORIAN. + * In this case, @c CALENDAR_GREGORIAN. */ virtual CalendarType GetType(void) const; @@ -350,10 +352,10 @@ public: * @param[out] isInDst Set to @c true if the current date is in DST, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. - * @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. + * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. + * @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. */ virtual result IsInDst(bool& isInDst) const; @@ -370,18 +372,18 @@ public: bool IsLeapYear(int year) const; - /* + /** * Sets the Gregorian Calendar change date. @n * This is the point when the switch from Julian dates to Gregorian dates occurred. * Default is 00:00:00 local time, Oct 15, 1582. Previous to this, dates are in the Julian calendar. * - * To obtain a pure Julian calendar, set the change @c change to MAX_MILLISECOND. - * To obtain a pure Gregorian calendar, set the change @c change to MIN_MILLISECOND. + * To obtain a pure Julian calendar, set @c change to @c MAX_MILLISECOND. + * To obtain a pure Gregorian calendar, set @c change to @c MIN_MILLISECOND. * * @since 2.0 * * @return An error code - * @param[in] change The given Gregorian cutover date + * @param[in] change The Gregorian cutover date * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ @@ -389,7 +391,7 @@ public: /** * Rolls up or down as per the specified amount in the specified field. @n - * This method overrides Calendar(). @n + * This method overrides Calendar().Roll(TimeField, int). @n * For more details, refer to Tizen::Locales::Calendar::Roll(TimeField, int). * * @since 2.0 @@ -399,37 +401,37 @@ public: * @param[in] amount The amount to roll up/down * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET). - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * If any time field value previously set is invalid, this exception is returned. + * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET). + * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. */ virtual result Roll(TimeField field, int amount); - /* - * Gets the millisecond which is midnight, local time at or before the Gregorian cutover. + /** + * Gets the midnight, local time at or before the Gregorian cutover in milliseconds. * * @since 2.0 * - * @return The millisecond which is midnight, local time at or before the Gregorian cutover - * If this method fails, @c -1 is returned. + * @return The midnight, local time at or before the Gregorian cutover in milliseconds. @n + * If this method fails, @c -1 is returned. @n * The specific error code can be accessed using the GetLastResult() method. */ long long GetNormalizedGregorianCutover(void) const; - /* + /** * Gets the year of the Gregorian cutover, with @c 0 representing 1 BC, @c -1 representing 2 BC, and so on. * * @since 2.0 * - * @return The year of the Gregorian cutover - * If this method fails, @c -1 is returned. + * @return The year of the Gregorian cutover @n + * If this method fails, @c -1 is returned. @n * The specific error code can be accessed using the GetLastResult() method. */ int GetGregorianCutoverYear(void) const; - /* + /** * Gets the Julian day number of the Gregorian cutover. * * @since 2.0 @@ -439,7 +441,7 @@ public: int GetCutoverJulianDay(void) const; - /* + /** * Checks whether the current calendar is a Gregorian calendar or not. * * @since 2.0 @@ -527,14 +529,14 @@ private: public: /* - * Defines the length of months. + * The length of months. * * @since 2.0 */ static const int MONTH_LENGTH[24]; /* - * Defines the days of a year. + * The days of a year. * * @since 2.0 */ diff --git a/inc/FLclLocale.h b/inc/FLclLocale.h index 058ab1b..5f8c396 100644 --- a/inc/FLclLocale.h +++ b/inc/FLclLocale.h @@ -60,7 +60,7 @@ enum CalendarType * @enum LanguageCode * * Defines the ISO 639-2 language code. @n - * The LanguageCode enumerator represents the ISO 639-2 language codes. @n + * This enum represents the ISO 639-2 language codes. @n * The specific LanguageCode represents the language code with the locale's ISO-15924 abbreviation script code. @n * The supported ISO-15924 script codes are Arabic, Cyrillic, Latin, Hans, Hant and Gurmukhi. * @@ -579,8 +579,8 @@ enum LanguageCode * @enum CountryCode * * Defines the ISO 3166-1 alpha-2 country code. @n - * The CountryCode enumerator represents the ISO 3166-1 alpha-2 country codes. - * The area code for Latin america and the Caribbean represents the ISO 3166-1 numeric-3. + * This enum represents the ISO 3166-1 alpha-2 country codes. + * The area code for Latin america and the Caribbean represents the ISO 3166-1 numeric-3 code. * * @since 2.0 */ @@ -843,7 +843,7 @@ enum CountryCode * * @final This class is not intended for extension. * - * @remarks For more information on the example codes for %Locale class, see LocaleManager. + * @remarks For more information on the example codes for the %Locale class, see LocaleManager. * * The %Locale class represents a specific geographical, political, or cultural region. @n * A %Locale object has three attributes: @@ -877,10 +877,10 @@ public: * * @since 2.0 * - * @param[in] languageCode The language code - * @param[in] countryCode The country code - * @param[in] pVariantCodeString A pointer to the variant code string @n - * It is converted to a uppercase letter if it is written in a lowercase letter. + * @param[in] languageCode The language code + * @param[in] countryCode The country code + * @param[in] pVariantCodeString A pointer to the variant code string @n + * It is converted to upper case letters if it is written in lower case letters. */ Locale(LanguageCode languageCode, CountryCode countryCode, const Tizen::Base::String* pVariantCodeString = null); @@ -888,10 +888,10 @@ public: * Assigns the value of the specified instance to the current instance of %Locale. @n * Copying of objects using this copy assignment operator is allowed. * - * @since 2.0 + * @since 2.0 * * @return A reference to the current instance of %Locale - * @param[in] otherLocale An instance of %Locale + * @param[in] otherLocale An instance of %Locale */ Locale& operator =(const Locale& otherLocale); @@ -906,11 +906,11 @@ public: /** * Compares the current instance of %Locale with the specified instance of %Locale. * - * @since 2.0 + * @since 2.0 * * @return @c true if the value of the specified instance is equal to the value of the current instance, @n * else @c false - * @param[in] otherLocale An instance of %Locale + * @param[in] otherLocale An instance of %Locale */ bool operator ==(const Locale& otherLocale) const; @@ -926,14 +926,14 @@ public: bool operator !=(const Locale& otherLocale) const; /** - * Converts the operand @c obj to an object of the %Locale type and then compares it with the current instance of %Locale. + * Converts the operand @c obj to an object of the %Locale type and compares it with the current instance of %Locale. * * @since 2.0 * * @return @c true if the value of the current instance is equal to the value of the specified Tizen::Base::Object, @n * else @c false - * @param[in] obj The object to compare with the current instance - * @see Tizen::Base::Object::Equals() + * @param[in] obj The object to compare with the current instance + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -972,7 +972,7 @@ public: * @since 2.0 * * @return The language code, @n - * The specific language code string has the locale's ISO-15924 abbreviation script code. + * The specific language code string has the locale's ISO-15924 abbreviation script code. */ Tizen::Base::String GetLanguageCodeString(void) const; @@ -991,7 +991,7 @@ public: * * @since 2.0 * - * @return The variant code string written in a uppercase letter even if it was set to a lowercase letter, @n + * @return The variant code string in upper case letters even if it was set to lower case letters, @n * else an empty string if the variant is not specified * @see SetVariantCodeString() */ @@ -1002,32 +1002,29 @@ public: * Gets the string representing the current instance of %Locale. @n * The string consists of the values returned by GetLanguageCodeString(), GetCountryCodeString(), and GetVariantCodeString() assembled into a string. * - * @since 2.0 + * @since 2.0 * - * @return A concatenated string with the language code string, country code string, and variant string @n - * For example, if the language code is LANGUAGE_ENG, country code is COUNTRY_US, and variant string is empty, @n + * @return The concatenated string with the language code string, country code string, and variant string @n + * For example, if the language code is ::LANGUAGE_ENG, country code is ::COUNTRY_US, and variant string is empty, @n * the locale code string is "eng_US". - * @see GetLanguageCodeString() - * @see GetCountryCodeString() - * @see GetVariantCodeString() */ Tizen::Base::String GetLocaleCodeString(void) const; /** - * Gets the country name of the current instance of %Locale that is appropriate for display to the user. @n + * Gets the country name of the current instance of %Locale that is appropriate for display. @n * The name is localized for this locale. For example, if this locale is eng_US, the name is "United States". * * @since 2.0 * * @return An error code - * @param[out] countryName The country name of the locale - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have country name entry in the database. + * @param[out] countryName The country name of the locale + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have a country name entry in the database. */ result GetCountryName(Tizen::Base::String& countryName) const; /** - * Gets the country name of the current instance of %Locale that is appropriate for display to the user in the specified %Locale. @n + * Gets the country name of the current instance of %Locale that is appropriate for display in the specified %Locale. @n * The country name is localized for the specified locale(@c otherLocale). For example, if * the current instance of %Locale is fra_FR and the @c otherLocale is eng_US, the name is "France"; * if the current instance is eng_US and the @c otherLocale is fra_FR, the name returned is "Etats-Unis". @@ -1035,29 +1032,28 @@ public: * @since 2.0 * * @return An error code - * @param[in] otherLocale An instance of %Locale according to which the country name of the specified %Locale is displayed - * @param[out] countryName The country name of the locale - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have country name entry in the database. + * @param[in] otherLocale An instance of %Locale to display the country name + * @param[out] countryName The country name of the locale + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have a country name entry in the database. */ result GetCountryName(const Locale& otherLocale, Tizen::Base::String& countryName) const; /** - * Gets the language name of the current instance of %Locale that is appropriate for display to the user. @n - * The name is localized for the locale. For example, if this locale is - * eng_US, the name is "English". + * Gets the language name of the current instance of %Locale that is appropriate for display. @n + * The name is localized for the locale. For example, if this locale is eng_US, the name is "English". * * @since 2.0 * * @return An error code - * @param[out] languageName The language name of the locale - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have country name entry in the database. + * @param[out] languageName The language name of the locale + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have a country name entry in the database. */ result GetLanguageName(Tizen::Base::String& languageName) const; /** - * Gets the language name of the current instance of %Locale that is appropriate for display to the user in the specified %Locale. @n + * Gets the language name of the current instance of %Locale that is appropriate for display in the specified %Locale. @n * The name is localized for the specified locale (@c otherLocale). For example, if * the current instance is fra_FR and the @c otherLocale is eng_US, the name is "French"; * if the current instance is engUS and the @c otherLocale is fra_FR, the name returned is "anglais". @@ -1065,20 +1061,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] otherLocale An instance of %Locale according to which the language name of the specified %Locale is displayed - * @param[out] languageName The language name of the locale - * @exception E_SUCCESS The method is successful. + * @param[in] otherLocale An instance of %Locale to display the language name + * @param[out] languageName The language name of the locale + * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have country name entry in the database. */ result GetLanguageName(const Locale& otherLocale, Tizen::Base::String& languageName) const; /** * Sets the variant code with the specified variant code string. @n - * The variant code string is converted to a uppercase letter even if it is set to a lowercase letter. + * The variant code string is converted to upper case letters even if it is set to lower case letters. * * @since 2.0 * - * @param[in] pVariantCode A pointer to the variant code + * @param[in] pVariantCode The pointer to the variant code */ void SetVariantCodeString(const Tizen::Base::String* pVariantCode = null); @@ -1088,92 +1084,93 @@ public: * @since 2.0 * * @param[in] languageCodeString The language code, @n - * To get the specified LanguageCode with the locale's ISO-15924 abbreviation script code, @n - * the form of languageCodeString should combine the ISO 639-2 language codes and the locale's ISO-15924 abbreviation script code by "-". @n - * For example, if the language code is "aze" and the script code is "latn", @n - * the languageCodeString is "aze-latn", and the LanguageCode is LANGUAGE_AZE_LATIN. - * @return An instance of LanguageCode associated with the @c languageCodeString. + * To get the specified language code with the locale's ISO-15924 abbreviation script code, + * the form of @c languageCodeString should combine the ISO 639-2 language codes and the locale's + * ISO-15924 abbreviation script code by "-". @n + * For example, if the language code is "aze" and the script code is "latn", + * the @c languageCodeString is "aze-latn", and the language code is @c LANGUAGE_AZE_LATIN. + * @return An instance of LanguageCode associated with @c languageCodeString. */ static LanguageCode StringToLanguageCode(const Tizen::Base::String& languageCodeString); /** - * Gets the country code equivalent to the specified country code string. + * Gets the country code equivalent of the specified country code string. * * @since 2.0 * * @param[in] countryCodeString The country code - * @return An instance of CountryCode associated with the @c countryCodeString. + * @return An instance of CountryCode associated with the @c countryCodeString. */ static CountryCode StringToCountryCode(const Tizen::Base::String& countryCodeString); /** - * Gets the language code string equivalent to the specified @c languageCode. + * Gets the language code string equivalent of the specified @c languageCode. * * @since 2.0 * * @param[in] languageCode The language code - * @return The language code string associated with the @c languageCode, @n - * else an empty string if languageCode is invalid. - * @see StringToLanguageCode() + * @return The language code string associated with @c languageCode, @n + * else an empty string if @c languageCode is invalid. + * @see StringToLanguageCode() */ static Tizen::Base::String LanguageCodeToString(LanguageCode languageCode); /** - * Gets the country code string equivalent to the specified @c countryCode. + * Gets the country code string equivalent of the specified @c countryCode. * * @since 2.0 * * @param[in] countryCode The country code - * @return The ISO 3166-1 alpha-2 country code string associated with the @c countryCode, @n - * else an empty string if countryCode is invalid. + * @return The ISO 3166-1 alpha-2 country code string associated with @c countryCode, @n + * else an empty string if @c countryCode is invalid. */ static Tizen::Base::String CountryCodeToString(CountryCode countryCode); /** - * Gets the 2-letter language code string equivalent to the specified @c languageCode. + * Gets the 2-letter language code string equivalent of the specified @c languageCode. * * @since 2.0 * * @param[in] languageCode The language code - * @return The ISO 639-2 language code string associated with the @c languageCode, @n - * or The ISO 639-2 language code string with the ISO-15924 script code @n - * if the @c languageCode represents The ISO 639-2 language code with the ISO-15924 script code, @n - * else an empty string if languageCode is invalid. + * @return The ISO 639-2 language code string associated with @c languageCode, @n + * or the ISO 639-2 language code string with the ISO-15924 script code if the @c languageCode represents + * the ISO 639-2 language code with the ISO-15924 script code, @n + * else an empty string if @c languageCode is invalid. */ static Tizen::Base::String LanguageCodeToTwoLetterLanguageCodeString(LanguageCode languageCode); /** - * Gets the language code equivalent to the specified 2-letter language code string. + * Gets the language code equivalent of the specified 2-letter language code string. * * @since 2.0 * * @param[in] languageCodeString The language code string - * @return An instance of LanguageCode associated with the @c languageCodeString. - * @see StringToLanguageCode() + * @return An instance of LanguageCode associated with @c languageCodeString. + * @see StringToLanguageCode() */ static LanguageCode TwoLetterLanguageCodeStringToLanguageCode(const Tizen::Base::String& languageCodeString); /** - * Gets the 3-letter country code string equivalent to the specified @c countryCode. + * Gets the 3-letter country code string equivalent of the specified @c countryCode. * * @since 2.0 * * @param[in] countryCode The country code - * @return The ISO 3166-1 alpha-3 country code string associated with the @c countryCode, @n - * else an empty string if countryCode is invalid - * @see CountryCodeToString() - * @remarks COUNTRY_AREA_419 returns an empty string, since it is not defined in the ISO 3166-1 alpha-3. + * @return The ISO 3166-1 alpha-3 country code string associated with @c countryCode, @n + * else an empty string if @c countryCode is invalid + * @remarks @c COUNTRY_AREA_419 returns an empty string, since it is not defined in the ISO 3166-1 alpha-3. + * @see CountryCodeToString() */ static Tizen::Base::String CountryCodeToThreeLetterCountryCodeString(CountryCode countryCode); /** - * Gets the country code equivalent to the specified 3-letter country code string. + * Gets the country code equivalent of the specified 3-letter country code string. * * @since 2.0 * * @param[in] countryCodeString The country code string - * @return An instance of CountryCode associated with the @c countryCodeString. - * @see StringToCountryCode() + * @return An instance of CountryCode associated with @c countryCodeString. + * @see StringToCountryCode() */ static CountryCode ThreeLetterCountryCodeStringToCountryCode(const Tizen::Base::String& countryCodeString); diff --git a/inc/FLclLocaleManager.h b/inc/FLclLocaleManager.h index f835d1b..54b5f16 100644 --- a/inc/FLclLocaleManager.h +++ b/inc/FLclLocaleManager.h @@ -34,13 +34,14 @@ namespace Tizen { namespace Locales /** * @class LocaleManager - * @brief This class is used for the %LocaleManager identification. + * @brief This class provides methods for %LocaleManager identification. * * @since 2.0 * * @final This class is not intended for extension. * - * The %LocaleManager class helps application programmers handle the system locale information of the device. Each device system has at least one installed locale and often has many locales from which the user can choose. + * The %LocaleManager class provides methods for the system locale information of the device. Each device system has at least + * one installed locale and often has many locales from which the user can choose. * * For more information on the class features, see Retrieving Language and Country Codes. @@ -140,12 +141,11 @@ class _OSP_EXPORT_ LocaleManager public: /** * This is the default constructor for this class. @n - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, the Construct() + * method must be called right after calling this constructor. * * @since 2.0 * - * @see Construct() - * */ LocaleManager(void); @@ -174,27 +174,29 @@ public: * * @since 2.0 * - * @return An instance of Locale + * @return The system locale * @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. - * The resulting Locale instance is Locale (LANGUAGE_INVALID, COUNTRY_INVALID). + * @exception E_SYSTEM A system error has occurred. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The resulting Locale instance is Locale(@c LANGUAGE_INVALID, @c COUNTRY_INVALID). */ Locale GetSystemLocale(void) const; /** - * Gets a list of all the available locales. + * Gets the list of all the available locales. * * @since 2.0 * - * @return A list of Locale instances, @n - * else @c null if the method fails + * @return The list of available locales, @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. - * @remarks The IList returned contains the list of all the locales installed on the system. - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The Tizen::Base::Collection::IList returned contains the list of all the locales installed on the system. + * - The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAvailableLocalesN(void) const; @@ -204,7 +206,7 @@ public: * * @since 2.0 * - * @return An instance of Tizen::Base::String (ISO 639-2 code format), @n + * @return The user selected language as an instance of Tizen::Base::String (ISO 639-2 code format), @n * else empty string if the method fails * @exception E_SUCCESS The method is successful. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -213,12 +215,13 @@ public: /** - * Gets a list of all the available languages supported by the device, which can be different according to the target country/region of the device. + * Gets the list of all the available languages supported by the device, which can be different according to the target + * country/region of the device. * * @since 2.0 * - * @return A list of Tizen::Base::String instances (ISO 639-2 code format), @n - * else @c null if the method fails + * @return The list of all available languages as Tizen::Base::String instances (ISO 639-2 code format), @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -228,12 +231,12 @@ public: /** - * Gets a list of all the available time zone IDs. + * Gets the list of all the available time zone IDs. * * @since 2.0 * - * @return A list of Tizen::Base::String instances, @n - * else @c null if the method fails + * @return The list of all available time zone IDs as Tizen::Base::String instances, @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -243,19 +246,20 @@ public: /** - * Gets a list of all the available time zone IDs with the specified Greenwich Mean Time (GMT) offset for this time zone. + * Gets the list of all the available time zone IDs with the specified Greenwich Mean Time (GMT) offset for this time zone. * * @since 2.0 * - * @return A list of Tizen::Base::String instances, @n - * else @c null if the method fails + * @return The list of all availabke time zone IDs with the GMT offset as Tizen::Base::String instances, @n + * else @c null if it fails * @param[in] rawOffset The specified GMT offset for this time zone (Daylight Saving Time (DST) is not considered) @n * The value of @c rawOffset is in minutes. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * If there are no time zones for the specified GMT offset, an empty list is returned. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If there are no time zones for the specified GMT offset, an empty list is returned. */ Tizen::Base::Collection::IList* GetAvailableTimeZonesN(int rawOffset) const; diff --git a/inc/FLclNumberFormatter.h b/inc/FLclNumberFormatter.h index b6037c1..77c0d4e 100644 --- a/inc/FLclNumberFormatter.h +++ b/inc/FLclNumberFormatter.h @@ -36,7 +36,10 @@ namespace Tizen { namespace Locales * * @since 2.0 * - * The %NumberFormatter class is used to format all number formats, including decimal and real numbers, currency, and percentage for any locale. It also provides methods to determine the locales that have number formats and their names. You can write codes completely independent of the locale conventions for decimal points, thousand separators as well as of the specific decimal digits used or whether the number format is a decimal. A normal decimal number can also be displayed as a currency or as a percentage. + * The %NumberFormatter class is used to format all number formats, including decimal and real numbers, currency, and percentage + * for any locale. It also provides methods to determine the locales that have number formats and their names. You can write + * codes completely independent of the locale conventions for decimal points, thousand separators, the specific + * decimal digits used, or the number format. A normal decimal number can also be displayed as a currency or as a percentage. * * For more information on the class features, see Number Formatters. * @@ -119,44 +122,44 @@ public: * Creates a number formatter for the specified locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here". * @endif * - * @return A pointer to a general number formatter for the specified @c locale, @n + * @return A pointer to the general number formatter for the specified @c locale, @n * else @c null if an error occurs * @param[in] locale An instance of Locale * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static NumberFormatter* CreateNumberFormatterN(const Locale& locale); /** * @if OSPCOMPAT - * @page CompNumberFormatterCreateNumberFormatterNPage Compatibility for CreateNumberFormatterN() - * @section CompNumberFormatterCreateNumberFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompNumberFormatterCreateNumberFormatterNSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * @page CompNumberFormatterCreateNumberFormatterNPage Compatibility for CreateNumberFormatterN() + * @section CompNumberFormatterCreateNumberFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompNumberFormatterCreateNumberFormatterNSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif - */ + */ /** * Creates a currency formatter for the default locale. * * @since 2.0 * - * @return A pointer to a currency formatter for the default locale, @n + * @return A pointer to the currency formatter for the default locale, @n * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -170,44 +173,44 @@ public: * Creates a currency formatter for the specified @c locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here". * @endif * - * @return A pointer to a currency formatter for the specified @c locale, @n + * @return A pointer to the currency formatter for the specified @c locale, @n * else @c null if an error occurs - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static NumberFormatter* CreateCurrencyFormatterN(const Locale& locale); /** * @if OSPCOMPAT - * @page CompNumberFormatterCreateCurrencyFormatterNPage Compatibility for CreateCurrencyFormatterN() - * @section CompNumberFormatterCreateCurrencyFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompNumberFormatterCreateCurrencyFormatterNSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompNumberFormatterCreateCurrencyFormatterNPage Compatibility for CreateCurrencyFormatterN() + * @section CompNumberFormatterCreateCurrencyFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompNumberFormatterCreateCurrencyFormatterNSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif - */ + */ /** * Creates a percentage formatter for the system locale. * * @since 2.0 * - * @return A pointer to a percentage formatter for the default locale, @n + * @return A pointer to the percentage formatter for the default locale, @n * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -221,37 +224,37 @@ public: * Creates a percentage formatter for the specified @c locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here". * @endif * - * @return A pointer to a percentage formatter for the specified @c locale, @n + * @return A pointer to the percentage formatter for the specified @c locale, @n * else @c null if an error occurs - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static NumberFormatter* CreatePercentFormatterN(const Locale& locale); - /** + /** * @if OSPCOMPAT - * @page CompNumberFormatterCreatePercentFormatterNPage Compatibility for CreatePercentFormatterN() - * @section CompNumberFormatterCreatePercentFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompNumberFormatterCreatePercentFormatterNSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompNumberFormatterCreatePercentFormatterNPage Compatibility for CreatePercentFormatterN() + * @section CompNumberFormatterCreatePercentFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompNumberFormatterCreatePercentFormatterNSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif - */ + */ @@ -262,7 +265,7 @@ public: * * @return An error code * @param[in] number The number of type Tizen::Base::Long to format - * @param[out] str The string to append to the resultant string + * @param[out] str The string to append * @exception E_SUCCESS The method is successful. */ virtual result Format(long number, Tizen::Base::String& str) const; @@ -275,7 +278,7 @@ public: * * @return An error code * @param[in] number The number of type Tizen::Base::Double to format - * @param[out] str The string to append to the resultant string + * @param[out] str The string to append * @exception E_SUCCESS The method is successful. */ virtual result Format(double number, Tizen::Base::String& str) const; @@ -290,19 +293,18 @@ public: * @remarks The initial value is derived in a locale dependent way. @n * The returned value may be @c null if no valid currency is determined * or no currency has been set using the SetCurrency() method. - * @see SetCurrency() */ virtual const Currency* GetCurrency(void) const; /** - * Sets the currency used by the current number format when formatting currency values. + * Sets the currency to be used by the current number format when formatting currency values. * - * @since 2.0 + * @since 2.0 * - * @param[in] currency The new currency to use by the current number format + * @param[in] currency The currency to set * @remarks This does not update the minimum or maximum number of fractional digits used by the number format. - * @see GetCurrency() + * @see GetCurrency() */ virtual void SetCurrency(const Currency& currency); @@ -325,7 +327,7 @@ public: * * @param[in] newValue The maximum number of integer digits allowed in the integer portion of a number, @n * If less than zero, @c 0 is used. - * @remarks The maximum integer digits must be greater than or equal to the minimum integer digits. + * @remarks The maximum integer digits must be greater than or equal to the minimum integer digits.@n * If the new value for the maximum integer digits is less than the current value of the minimum integer digits, * the minimum integer digits are also set to the new value. * @see GetMaxIntegerDigits() @@ -338,7 +340,7 @@ public: * * @since 2.0 * - * @return An integer value representing the minimum number of digits allowed in the integer portion of a number + * @return An integer value representing the minimum number of digits * @see SetMinIntegerDigits() */ virtual int GetMinIntegerDigits(void) const; @@ -349,9 +351,9 @@ public: * * @since 2.0 * - * @param[in] newValue The minimum number of integer digits allowed in the integer portion of a number @n - * If less than zero, @c 0 is used. - * @remarks The minimum integer digits must be less than or equal to the maximum integer digits. + * @param[in] newValue The minimum number of integer digits allowed in the integer portion of a number @n + * If less than zero, @c 0 is used. + * @remarks The minimum integer digits must be less than or equal to the maximum integer digits. @n * If the new value for the minimum integer digits exceeds the current value of the maximum integer digits, * the maximum integer digits are also set to the new value. * @see GetMinIntegerDigits() @@ -364,7 +366,7 @@ public: * * @since 2.0 * - * @return An integer value representing the maximum number of digits allowed in the fractional portion of a number + * @return An integer value representing the maximum number of digits * @see SetMaxFractionDigits() */ virtual int GetMaxFractionDigits(void) const; @@ -377,7 +379,7 @@ public: * * @param[in] newValue The maximum number of fractional digits allowed in the fractional portion of a number @n * If less than zero, @c 0 is used. - * @remarks The maximum fractional digits must be greater than or equal to the minimum fractional digits. + * @remarks The maximum fractional digits must be greater than or equal to the minimum fractional digits. @n * If the new value for the maximum fractional digits is less than the current value of the minimum fractional digits, * the minimum fractional digits are also set to the new value. * @see GetMaxFractionDigits() @@ -403,7 +405,7 @@ public: * * @param[in] newValue The minimum number of fractional digits allowed in the fractional portion of a number @n * If less than zero, @c 0 is used. - * @remarks The minimum fractional digits must be less than or equal to the maximum fractional digits. + * @remarks The minimum fractional digits must be less than or equal to the maximum fractional digits. @n * If the new value for the minimum fractional digits exceeds the current value of the maximum fraction digits, * the maximum fraction digits are also set to the new value. * @see GetMinFractionDigits() @@ -418,9 +420,10 @@ public: * * @return @c true if grouping is used in the current instance of %NumberFormatter, @n * else @c false - * @remarks For example, in the English locale, with grouping on, the number 1234567 + * @remarks + * - For example, in the English locale, with grouping on, the number 1234567 * might be formatted as "1,234,567". - * The grouping separator as well as the size of each group is locale dependent + * - The grouping separator as well as the size of each group is locale dependent * and is determined by subclasses of %NumberFormatter. * @see SetGroupingUsed() */ @@ -428,11 +431,11 @@ public: /** - * Sets the current instance of %NumberFormatter to use or not to use grouping. + * Sets the use of grouping in the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue Set to @c true if grouping is used in the current formatter, @n + * @param[in] newValue Set to @c true to use grouping in the current formatter, @n * else @c false * @see IsGroupingUsed() */ @@ -440,15 +443,15 @@ public: /** - * Applies the specified pattern to the current instance of %NumberFormatter. + * Applies the pattern to the current instance of %NumberFormatter. * * @since 2.0 * * @return An error code - * @param[in] pattern The new pattern - * @param[in] localized The localization On/Off flag @n + * @param[in] pattern The pattern to apply + * @param[in] localized The flag to set the localization on or off @n * Set to @c true if the pattern is applied with the localized symbols, @n - * else @c false. + * else @c false * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c pattern is invalid or its length is @c 0. */ @@ -468,11 +471,11 @@ public: /** - * Sets a new value for the positive prefix of the current instance of %NumberFormatter. + * Sets the positive prefix of the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue The new positive prefix + * @param[in] newValue The positive prefix to set * @see GetPositivePrefix() */ void SetPositivePrefix(const Tizen::Base::String& newValue); @@ -491,11 +494,11 @@ public: /** - * Sets a new value for the negative prefix of the current instance of %NumberFormatter. + * Sets the negative prefix of the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue The new negative prefix + * @param[in] newValue The negative prefix to set * @see GetNegativePrefix() */ void SetNegativePrefix(const Tizen::Base::String& newValue); @@ -514,11 +517,11 @@ public: /** - * Sets a new value for the positive suffix of the current instance of %NumberFormatter. + * Sets the positive suffix of the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue The new positive suffix + * @param[in] newValue The positive suffix to set * @see GetPositiveSuffix() */ void SetPositiveSuffix(const Tizen::Base::String& newValue); @@ -537,11 +540,11 @@ public: /** - * Sets a new value for the negative suffix of the current instance of %NumberFormatter. + * Sets the negative suffix of the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue The new negative suffix + * @param[in] newValue The negative suffix to set * @see GetNegativeSuffix() */ void SetNegativeSuffix(const Tizen::Base::String& newValue); @@ -560,11 +563,11 @@ public: /** - * Sets a new value for the multiplier for use in percent, per mill, and so on. + * Sets the multiplier for use in percent, per mill, and so on. * * @since 2.0 * - * @param[in] newValue The new value for the multiplier + * @param[in] newValue The multiplier to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks For example, in percentage, set the suffixes to have "%" and the multiplier to be 100. @@ -579,8 +582,8 @@ public: * @since 2.0 * * @return An integer value representing the grouping size - * @remarks Grouping size is the number of digits between grouping separators in the integer portion of a number. @n - * For example, in the number "123,456.78", the grouping size is 3. + * @remarks The grouping size is the number of digits between the grouping separators in the integer portion of a number. @n + * For example, in the number "123,456.78", the grouping size is 3. * @see SetGroupingSize() * @see IsGroupingUsed() */ @@ -588,11 +591,11 @@ public: /** - * Sets a new value for the grouping size. + * Sets the grouping size. * * @since 2.0 * - * @param[in] newValue The new value for the grouping size + * @param[in] newValue The grouping size to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @see GetGroupingSize() @@ -615,12 +618,12 @@ public: /** - * Sets the behavior of the decimal separator. @n + * Sets the visibility behavior of the decimal separator. @n * The decimal separator can be set to always appear using this method. * * @since 2.0 * - * @param[in] newValue Set to @c true if the decimal separator is always shown, @n + * @param[in] newValue Set to @c true to always show the decimal separator, @n * else @c false * @see IsDecimalSeparatorAlwaysShown() */ @@ -641,12 +644,12 @@ public: /** - * Sets the behavior of the plus sign. @n + * Sets the visibility behavior of the plus sign. @n * The plus sign can be set to always appear using this method. * * @since 2.0 * - * @param[in] newValue Set to @c true if the plus sign is always shown, @n + * @param[in] newValue Set to @c true to always show the plus sign, @n * else @c false * @see IsPositiveSignAlwaysShown() */ diff --git a/inc/FLclNumberSymbols.h b/inc/FLclNumberSymbols.h index 98bb43d..983cff4 100644 --- a/inc/FLclNumberSymbols.h +++ b/inc/FLclNumberSymbols.h @@ -61,12 +61,14 @@ enum NumberSymbol /** * @class NumberSymbols - * @brief This class provides methods that help in providing number symbols. + * @brief This class provides methods for number symbols. * * @since 2.0 * - * The %NumberSymbols class represents the set of symbols (such as the decimal separator and the grouping separator) needed by NumberFormatter to format numbers. - * %NumberFormatter creates its own instance of %NumberSymbols from its locale data. %NumberSymbols can be adopted by a %NumberFormatter instance, or it can be specified when a %NumberFormatter is created. If you need to change any of these symbols, you can get the %NumberSymbols instance from your %NumberFormatter and then modify it. + * The %NumberSymbols class represents the set of symbols (such as the decimal separator and the grouping separator) needed by + * NumberFormatter to format numbers. %NumberFormatter creates its own instance of %NumberSymbols from its locale data. + * %NumberSymbols can be adapted by a %NumberFormatter instance, or it can be specified when a %NumberFormatter is created. + * If you need to change any of these symbols, you can get the %NumberSymbols instance from your %NumberFormatter and then modify it. * * For more information on the class features, see Number Symbols and Currencies. */ @@ -76,11 +78,10 @@ class _OSP_EXPORT_ NumberSymbols public: /** * This is the default constructor for this class. @n - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, the Construct() + * method must be called right after calling this constructor. * - * @since 2.0 - * - * @see Construct() + * @since 2.0 */ NumberSymbols(void); @@ -97,35 +98,35 @@ public: * Initializes this instance of %NumberSymbols with the specified @c locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompNumberSymbolsConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompNumberSymbolsConstructPage "here". * @endif * * @return An error code - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c locale is invalid. */ result Construct(const Locale& locale); /** * @if OSPCOMPAT - * @page CompNumberSymbolsConstructPage Compatibility for Construct() - * @section CompNumberSymbolsConstructIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompNumberSymbolsConstructSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompNumberSymbolsConstructPage Compatibility for Construct() + * @section CompNumberSymbolsConstructIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompNumberSymbolsConstructSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif - */ + */ /** * Gets the character used for number format. @@ -135,7 +136,7 @@ public: * @return The character used for number format, @n * else an empty string if the @c symbol is invalid * @param[in] symbol The number format symbol instance - * @see SetNumberSymbol() + * @see SetNumberSymbol() */ Tizen::Base::String GetNumberSymbol(NumberSymbol symbol) const; @@ -149,7 +150,7 @@ public: * @param[in] symbol A symbol to set * @param[in] str The new string for symbol * @exception E_SUCCESS The method is successful. - * @see GetNumberSymbol() + * @see GetNumberSymbol() */ result SetNumberSymbol(NumberSymbol symbol, const Tizen::Base::String& str); @@ -160,7 +161,7 @@ public: * @since 2.0 * * @return A pointer to the current instance of Locale, @n - * else @c null if this method fails + * else @c null if it fails * @remarks The specific error code can be accessed using the GetLastResult() method. */ const Locale* GetLocale(void) const; diff --git a/inc/FLclTimeRule.h b/inc/FLclTimeRule.h index 838aa60..8002ff3 100644 --- a/inc/FLclTimeRule.h +++ b/inc/FLclTimeRule.h @@ -31,7 +31,7 @@ namespace Tizen { namespace Locales /** * @class TimeRule - * @brief This class is for setting and getting the time rule. + * @brief This class provides methods for setting and getting the time rule. * * @since 2.0 * @@ -153,7 +153,7 @@ public: * @param[in] day The day * @param[in] hour The hour * @param[in] minute The minute - * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL + * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL */ TimeRule(Month month, int day, int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL); @@ -168,7 +168,7 @@ public: * @param[in] dayOfWeek The day of the week * @param[in] hour The hour * @param[in] minute The minute - * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL + * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL */ TimeRule(Month month, Week week, DayOfWeek dayOfWeek, int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL); @@ -188,7 +188,7 @@ public: * @b on @b or @b before @c day * @param[in] hour The hour * @param[in] minute The minute - * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL + * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL */ TimeRule(Month month, int day, DayOfWeek dayOfWeek, bool onOrAfterDay, int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL); @@ -274,8 +274,8 @@ public: * @since 2.0 * * @return @c true if the value of the specified instance is equal to that of the current instance, @n - * else @c false - * @param[in] obj The object to compare with the current instance + * else @c false + * @param[in] obj The object to compare with the current instance */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -297,13 +297,13 @@ private: * @param[in] day The day * @param[in] week The week * @param[in] dayOfWeek The day of week - * @param[in] beforeAfter If @c after is ON_OR_AFTER_DAY, this rule selects the first @c dayOfWeek + * @param[in] beforeAfter If @c after is @c ON_OR_AFTER_DAY, this rule selects the first @c dayOfWeek * @b on @b or @b after @c day. - * If @c after is ON_OR_BEFORE_DAY, this rule selects the last @c dayOfWeek + * If @c after is @c ON_OR_BEFORE_DAY, this rule selects the last @c dayOfWeek * @b on @b or @b before @c day. * @param[in] hour The hour * @param[in] minute The minute - * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, TIME_MODE_WALL + * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, @c TIME_MODE_WALL */ void SetValue(Month month, int day, Week week, DayOfWeek dayOfWeek, bool onOrAfterDay, int hour, diff --git a/inc/FLclTimeZone.h b/inc/FLclTimeZone.h index bfddbe9..7a93546 100644 --- a/inc/FLclTimeZone.h +++ b/inc/FLclTimeZone.h @@ -40,15 +40,14 @@ namespace Tizen { namespace Locales * * @final This class is not intended for extension. * - * The %TimeZone class represents a time zone offset and figures out Daylight Saving Time (DST). + * The %TimeZone class represents the time zones and offers methods for time zone offset and Daylight Saving Time (DST). + * The time zone ID format is "Area/Location". @n + * However, the specialized time zone IDs have a different format, such as CST6CDT, EST5EDT and so on. @n * - * The form of time zone ID is "Area/Location". @n + * For more information on IDs, see Time Zone Database. @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 Time Zone Database. @n - * - * The supported time zone list depends on the device. Therefore, it must be checked by using LocaleManager::GetAvailableTimeZonesN(). + * The supported time zone list depends on the device. Therefore, you must call LocaleManager::GetAvailableTimeZonesN() to get + * the supported time zones. * * For more information on the class features, see Time Zones. * @@ -136,15 +135,16 @@ public: * * @param[in] rawOffset The base time zone offset to GMT in minutes * @param[in] id The time zone ID - * @remarks The form of time zone @c id is "Area/Location". @n For more information on IDs, refer here. @n - * However, the supported time zone list depends on the device. Therefore, it must be checked before using this method. - * @see LocaleManager::GetAvailableTimeZonesN() + * @remarks The format of time zone @c id is "Area/Location". @n + * For more information on IDs, refer here. @n + * However, the supported time zone list depends on the device. Therefore, you must call + * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones. */ TimeZone(int rawOffset, const Tizen::Base::String& id); /** * Initializes this instance of %TimeZone with the specified raw GMT offset, - * the ID of the time zone, the rules for starting/ending DST, and the DST offset. + * the time zone ID, the rules for starting/ending DST, and the DST offset. * * @since 2.0 * @@ -153,15 +153,16 @@ public: * @param[in] startRule The DST starting rule * @param[in] endRule The DST end rule * @param[in] dstOffset The amount of time in minutes saved during DST - * @remarks The form of time zone @c id is "Area/Location". @n For more information on IDs, refer here. @n - * However, the supported time zone list depends on the device. Therefore, it must be checked before using this method. - * @see LocaleManager::GetAvailableTimeZonesN() + * @remarks The form of time zone @c id is "Area/Location". @n + * For more information on IDs, refer here. @n + * However, the supported time zone list depends on the device. Therefore, you must call + * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones. */ TimeZone(int rawOffset, const Tizen::Base::String& id, const TimeRule& startRule, const TimeRule& endRule, int dstOffset); /** - * Checks whether the specified instance of %TimeZone equals the value of the current instance. + * Checks whether the specified %TimeZone instance is equal to the current instance. * * @since 2.0 * @@ -172,7 +173,7 @@ public: bool operator ==(const TimeZone& otherTimeZone) const; /** - * Checks whether the %TimeZone instance is equal to the current instance. + * Checks whether the specified %TimeZone instance is equal to the current instance. * * @since 2.0 * @@ -188,8 +189,8 @@ public: * @since 2.0 * * @return @c true if the value of the specified instance is equal to that of the current instance, @n - * else @c false - * @param[in] obj The object to compare with the current instance + * else @c false + * @param[in] obj The object to compare with the current instance */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -275,7 +276,7 @@ public: /** * Converts the Coordinated Universal Time (UTC) time to the standard time. * - * @since 2.0 + * @since 2.0 * * @return The standard time * @param[in] utcTime The UTC time @@ -305,7 +306,7 @@ public: /** * Converts the wall time to the UTC time. * - * @since 2.0 + * @since 2.0 * * @return The UTC time * @param[in] wallTime The wall time @@ -336,13 +337,13 @@ public: /** * Gets the raw and GMT offset for the specified instance of Tizen::Base::DateTime in the current time zone. * - * @if OSPCOMPAT - * @brief [Compatibility] + * @if OSPCOMPAT + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompTimeZoneGetOffsetPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompTimeZoneGetOffsetPage "here". * @endif * * @return An error code @@ -353,22 +354,23 @@ public: * @param[out] dstOffset The offset to add to @c rawOffset to obtain the total offset between the local and GMT time @n * If DST is not in effect, it is zero. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c date is invalid. - * @remarks Local millisecond = GMT milliseconds + rawOffset(in milliseconds) + dstOffset(in milliseconds). - * All computations are performed in Gregorian calendar. + * @exception E_INVALID_ARG The specified @c date is invalid. + * @remarks Local millisecond = GMT milliseconds + rawOffset(in milliseconds) + dstOffset(in milliseconds). @n + * All computations are performed in Gregorian calendar. */ result GetOffset(const Tizen::Base::DateTime& date, bool local, int& rawOffset, int& dstOffset) const; /** - * Gets the difference in minutes between the local standard time and GMT, taking into consideration both the raw offset and the effect of DST. + * Gets the difference in minutes between the local standard time and GMT, taking into consideration both the raw offset + * and the effect of DST. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompTimeZoneGetOffsetPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompTimeZoneGetOffsetPage "here". * @endif * * @return An error code @@ -376,24 +378,24 @@ public: * The value is GMT time from starting day (Jan 1, 1.). * @param[out] offset The offset between the local standard time and GMT, taking into consideration DST * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c ticks is invalid. - * @see Base::DateTime::GetTicks() + * @exception E_INVALID_ARG The specified @c ticks is invalid. + * @see Base::DateTime::GetTicks() */ result GetOffset(long long ticks, int& offset) const; - /** + /** * @if OSPCOMPAT - * @page CompTimeZoneGetOffsetPage Compatibility for GetOffset() - * @section CompTimeZoneGetOffsetIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_OUT_OF_RANGE if an argument is invalid. - * - * @section CompTimeZoneGetOffsetSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if an argument is invalid. + * @page CompTimeZoneGetOffsetPage Compatibility for GetOffset() + * @section CompTimeZoneGetOffsetIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_OUT_OF_RANGE if an argument is invalid. + * + * @section CompTimeZoneGetOffsetSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns @c E_INVALID_ARG if an argument is invalid. * @endif - */ + */ /** * Gets the difference in minutes between the local standard time and GMT, without including DST (that is, raw offset). @@ -406,11 +408,11 @@ public: int GetRawOffset(void) const; /** - * Gets the ID of the time zone. + * Gets the time zone ID. * * @since 2.0 * - * @return The ID of the time zone + * @return The time zone ID */ Tizen::Base::String GetId(void) const; @@ -455,38 +457,38 @@ public: static TimeZone GetGmtTimeZone(void); /** - * Gets the time zone instance from the given ID. + * Gets the time zone instance for the specified ID. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompTimeZoneGetTimeZonePage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompTimeZoneGetTimeZonePage "here". * @endif * * @return An error code * @param[in] id The time zone ID - * @param[out] timeZone The time zone for the given ID + * @param[out] timeZone The time zone for the specified ID * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c id is invalid. - * @remarks The %TimeZone instance for the specified @c id does not contain the DST information. - * The supported time zone list depends on the device. Therefore, it should be checked before using this method. - * @see LocaleManager::GetAvailableTimeZonesN() + * @exception E_INVALID_ARG The specified @c id is invalid. + * @remarks The %TimeZone instance for the specified @c id does not contain the DST information.@n + * The supported time zone list depends on the device. Therefore, you must call + * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones. */ static result GetTimeZone(const Tizen::Base::String& id, Tizen::Locales::TimeZone& timeZone); /** - * Gets the %TimeZone instance from the specified ID and UTC time. + * Gets a %TimeZone instance from the specified ID and UTC time. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompTimeZoneGetTimeZonePage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompTimeZoneGetTimeZonePage "here". * @endif * * @return An error code @@ -494,26 +496,26 @@ public: * @param[in] utcTime The UTC time * @param[out] timeZone The time zone for the specified ID and UTC time * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c id is invalid. - * @remarks The %TimeZone instance for the specified ID and UTC time contains the DST information. - * The supported time zone list depends on the device. Therefore, it should be checked before using this method. - * @see LocaleManager::GetAvailableTimeZonesN() + * @exception E_INVALID_ARG The specified @c id is invalid. + * @remarks The %TimeZone instance for the specified ID and UTC time contains the DST information. @n + * The supported time zone list depends on the device. Therefore, you must call + * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones. */ static result GetTimeZone(const Tizen::Base::String& id, const Tizen::Base::DateTime& utcTime, Tizen::Locales::TimeZone& timeZone); - /** + /** * @if OSPCOMPAT - * @page CompTimeZoneGetTimeZonePage Compatibility for GetTimeZone() - * @section CompTimeZoneGetTimeZoneIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the time zone ID is invalid. - * - * @section CompTimeZoneGetTimeZoneSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompTimeZoneGetTimeZonePage Compatibility for GetTimeZone() + * @section CompTimeZoneGetTimeZoneIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the time zone ID is invalid. + * + * @section CompTimeZoneGetTimeZoneSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the time zone ID is invalid. + * -# The method returns @c E_INVALID_ARG if the time zone ID is invalid. * @endif - */ + */ /** * Converts the UTC time to the standard time. @@ -532,7 +534,7 @@ public: * @since 2.0 * * @return The UTC time - * @param[in] standardTime The standard time + * @param[in] standardTime The standard time * @param[in] rawOffset The time zone's raw offset in minutes */ static Tizen::Base::DateTime StandardTimeToUtcTime(const Tizen::Base::DateTime& standardTime, int rawOffset); @@ -543,7 +545,7 @@ public: * @since 2.0 * * @return The wall time - * @param[in] utcTime The UTC time + * @param[in] utcTime The UTC time * @param[in] rawOffset The time zone's raw offset in minutes * @param[in] dstOffset The amount of time in minutes saved during DST */ @@ -555,7 +557,7 @@ public: * @since 2.0 * * @return The UTC time - * @param[in] wallTime The wall time + * @param[in] wallTime The wall time * @param[in] rawOffset The time zone's raw offset in minutes * @param[in] dstOffset The amount of time in minutes saved during DST */ diff --git a/inc/FLocales.h b/inc/FLocales.h index 2f2784e..1fdc48b 100644 --- a/inc/FLocales.h +++ b/inc/FLocales.h @@ -46,9 +46,11 @@ * @b Library: @b osp-appfw * * - * The %Locales namespace contains classes representing a specific cultural region (locale) and the classes for manipulating and formatting locale-sensitive information, such as dates, times, numbers, and time zones. + * The %Locales namespace contains classes representing a specific cultural region (locale) and the classes for manipulating and + * formatting locale-sensitive information, such as dates, times, numbers, and time zones. * - * Even if the list of all the available languages supported by the device is different, the localized information by the %Locales namespace should be represented properly. + * Even if the list of all the available languages supported by the device is different, the localized information by + * the %Locales namespace should be represented properly. * * For more information on the %Locales namespace features, see Locales Guide. * diff --git a/inc/FSysAlarm.h b/inc/FSysAlarm.h index 4436b99..b1da170 100644 --- a/inc/FSysAlarm.h +++ b/inc/FSysAlarm.h @@ -48,11 +48,12 @@ class _OSP_EXPORT_ Alarm { public: /** - * This is the default constructor for this class. + * This is the default constructor for this class. @n + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 * - * @remarks The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. */ Alarm(void); @@ -85,67 +86,73 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/alarm * - * @return An error code - * @param[in] duetime The time for the alarm to ring @n Any value with a unit that is less than a second is ignored. - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] duetime The time for the alarm to ring @n + * Any value with a unit that is less than a second is ignored. + * @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 The specified @c duetime is invalid. - * @exception E_SYSTEM A system error has occurred. - * @remarks If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically. + * @exception E_SYSTEM A system error has occurred. + * @remarks If this %Alarm instance is already registered by this method, the existing alarm is cancelled automatically. */ result Set(const Tizen::Base::DateTime& duetime); /** * Sets a repeating alarm. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/alarm * - * @return An error code - * @param[in] start The time for the alarm to ring first @n Any value with a unit that is less than a second is ignored. - * @param[in] period The interval in minutes between consecutive alarm rings - * @param[in] pEnd The time for the alarm ring to end @n Any value with a unit that is less than a second is ignored. - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] start The time for the alarm to ring first @n + * Any value with a unit that is less than a second is ignored. + * @param[in] period The interval in minutes between consecutive alarm rings + * @param[in] pEnd The time for the alarm ring to end @n + * Any value with a unit that is less than a second is ignored. + * @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. - * @exception E_SYSTEM A system error has occurred. - * @remarks If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically. @n If @c pEnd is @c null, the alarm repeats forever. + * @exception E_SYSTEM A system error has occurred. + * @remarks + * - If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically. + * - If @c pEnd is @c null, the alarm repeats forever. */ result Set(const Tizen::Base::DateTime& start, int period, const Tizen::Base::DateTime* pEnd = null); /** * Cancels the alarm. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/alarm * - * @return An error code - * @exception E_SUCCESS The method is successful. + * @return An error code + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. */ result Cancel(void); /** * Gets the start time for the current instance of %Alarm. * - * @since 2.0 + * @since 2.0 * - * @return An instance of Tizen::Base::DateTime indicating the start time for the alarm - * @remarks If this %Alarm instance is not registered by the Set() method, return value is default value of the Tizen::Base::DateTime class. + * @return An instance of Tizen::Base::DateTime indicating the start time for the alarm + * @remarks If this %Alarm instance is not registered by the Set() method, the return value is the default value of + * the Tizen::Base::DateTime instance. */ const Tizen::Base::DateTime GetStartTime(void) const; /** * Gets the period of the current instance of %Alarm in minutes. * - * @since 2.0 + * @since 2.0 * - * @return The period of the current instance of %Alarm in minutes + * @return The period of the current instance of %Alarm in minutes * @remarks If this %Alarm instance is not registered by the Set() method, return value is @c 0. */ int GetPeriod(void) const; @@ -155,7 +162,7 @@ public: * * @since 2.0 * - * @return A pointer to Tizen::Base::DateTime indicating the end time for the alarm, @n + * @return A pointer to Tizen::Base::DateTime indicating the end time for the alarm, @n * else @c null if the end time has not been set */ const Tizen::Base::DateTime* GetEndTime(void) const; diff --git a/inc/FSysBattery.h b/inc/FSysBattery.h index 7cc8b14..9a995ec 100644 --- a/inc/FSysBattery.h +++ b/inc/FSysBattery.h @@ -42,9 +42,8 @@ namespace Tizen { namespace System * @deprecated This class is deprecated. Instead of using this class, use the PowerManager class. * @final This class is not intended for extension. * - * The %Battery class provides methods to get the status related to battery levels and - * determine whether the battery is currently being charged. - * You cannot create an instance of this class directly. + * The %Battery class provides methods to get the status related to battery levels and determine whether the battery is + * currently being charged. You cannot create an instance of this class directly. * * For more information on the class features, see Battery Status. * @endif @@ -66,12 +65,12 @@ public: * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompGetCurrentLevelInPercentage "here". * @endif - * @return An error code - * @param[out] level The percentage of the charge remaining in the battery - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[out] level The percentage of the charge remaining in the battery + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The battery service is not available. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The resolution of the level is @c 1% since 2.0. The range of the level is @c 0 (Minimum) to @c 100 (Maximum). + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The resolution of the level is @c 1% since 2.0. The range of the level is @c 0 (Minimum) to @c 100 (Maximum). * @endcond */ static result GetCurrentLevelInPercentage(int& level); @@ -102,11 +101,11 @@ public: * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompGetCurrentLevel "here". * @endif - * @return An error code + * @return An error code * @param[out] level A value from the enumerator BatteryLevel indicating the current charging level - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The battery service is not available. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @endcond */ static result GetCurrentLevel(BatteryLevel& level); @@ -139,10 +138,10 @@ public: * @endif * @return An error code * @param[out] charging Set to @c true if the charging cable is connected to the phone, @n - * else @c false - * @exception E_SUCCESS The method is successful. + * else @c false + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The battery service is not available. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @endcond */ static result IsCharging(bool& charging); diff --git a/inc/FSysDeviceManager.h b/inc/FSysDeviceManager.h index 85ce055..9e0441b 100644 --- a/inc/FSysDeviceManager.h +++ b/inc/FSysDeviceManager.h @@ -69,9 +69,8 @@ enum DeviceType * * @final This class is not intended for extension. * - * The %DeviceManager class provides listener to handle events for various external device, - * such as a Bluetooth headset, HDMI, and headphone. - * This class also gets the current state of the device. You cannot create an instance of this class directly. + * The %DeviceManager class provides listeners to handle events for various external device, such as a Bluetooth headset, HDMI, + * and headphone. This class also gets the current state of the device. You cannot create an instance of this class directly. * * For more information on the class features, see External Device Management. * @@ -89,19 +88,19 @@ public: * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.0. @n - * For more information, see @ref DeviceManagerGetStatePage "here". + * For more information, see @ref DeviceManagerGetStatePage "here". * @endif * * @param[in] deviceType The value from the enumerator DeviceType indicating the device * @param[out] state The device state of type Tizen::Base::String * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result GetState(DeviceType deviceType, Tizen::Base::String& state); @@ -111,31 +110,31 @@ public: * @page DeviceManagerGetStatePage Compatibility for GetState() * @section DeviceManagerGetStatePageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * The GetState() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * The GetState() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerGetStatePageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Adds a device event listener. + * Adds the device event listener. * * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.0. @n * For more information, see @ref DeviceManagerAddDeviceEventListenerPage "here". * @endif * - * @return An error code - * @param[in] deviceType The types of a device - * @param[in] listener The device event listener - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. - * @exception E_OBJ_ALREADY_EXIST The specified @c deviceType and @c listener are already registered. + * @return An error code + * @param[in] deviceType The device type + * @param[in] listener The device event listener + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @exception E_OBJ_ALREADY_EXIST The specified @c deviceType and @c listener are already registered. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result AddDeviceEventListener(DeviceType deviceType, IDeviceEventListener& listener); @@ -145,24 +144,24 @@ public: * @page DeviceManagerAddDeviceEventListenerPage Compatibility for AddDeviceEventListener() * @section DeviceManagerAddDeviceEventListenerPageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * This AddDeviceEventListener() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * This AddDeviceEventListener() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerAddDeviceEventListenerPageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Removes a device event listener from all types of devices. + * Removes the device event listener from all types of devices. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] deviceType The types of a device - * @param[in] listener The device event listener - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. - * @exception E_OBJ_NOT_FOUND The specified @c deviceType and @c listener are not registered. + * @return An error code + * @param[in] deviceType The types of a device + * @param[in] listener The device event listener + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @exception E_OBJ_NOT_FOUND The specified @c deviceType and @c listener are not registered. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result RemoveDeviceEventListener(DeviceType deviceType, IDeviceEventListener& listener); @@ -172,18 +171,18 @@ public: * @page DeviceManagerRemoveDeviceEventListenerPage Compatibility for RemoveDeviceEventListener() * @section DeviceManagerRemoveDeviceEventListenerPageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * This RemoveDeviceEventListener() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * This RemoveDeviceEventListener() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerRemoveDeviceEventListenerPageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Removes all device event listeners. + * Removes all the device event listeners. * - * @since 2.0 + * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ diff --git a/inc/FSysEnvironment.h b/inc/FSysEnvironment.h index f039d85..5874d4f 100644 --- a/inc/FSysEnvironment.h +++ b/inc/FSysEnvironment.h @@ -72,7 +72,7 @@ class _OSP_EXPORT_ Environment public: /** - * Gets the path for the media directory that is usually used to store media contents. + * Gets the path for the media directory that stores the media contents. * * @since 2.0 * @@ -81,7 +81,7 @@ public: static Tizen::Base::String GetMediaPath(void); /** - * Gets the path for the default download directory that is usually used to store downloaded contents by the Tizen::Content::DownloadManager class. + * Gets the path for the default download directory that stores the downloaded contents by the Tizen::Content::DownloadManager class. * * @since 2.0 * @@ -101,14 +101,14 @@ public: /** * Gets the directory path according to the pre-defined directory type. * - * @since 2.0 + * @since 2.0 * - * @return The pre-defined directory path according to the specified @c dirType, @n - * else an empty string if the specified @c dirType is invalid - * @param[in] dirType The pre-defined directory type - * @remarks The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist, - * so you must make sure that it exists before using it. - * @see Tizen::Io::Directory::Create() + * @return The pre-defined directory path according to the specified @c dirType, @n + * else an empty string if the specified @c dirType is invalid + * @param[in] dirType The pre-defined directory type + * @remarks The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist, + * so you must make sure that it exists before using it. + * @see Tizen::Io::Directory::Create() */ static Tizen::Base::String GetPredefinedPath(PredefinedDirectoryType dirType); diff --git a/inc/FSysIAlarmEventListener.h b/inc/FSysIAlarmEventListener.h index b3e9ff6..23c33eb 100644 --- a/inc/FSysIAlarmEventListener.h +++ b/inc/FSysIAlarmEventListener.h @@ -35,7 +35,7 @@ class Alarm; /** * @interface IAlarmEventListener - * @brief This interface is the listener of the alarm event. + * @brief This interface is the listener of the alarm event. * * @since 2.0 * @@ -47,7 +47,9 @@ class _OSP_EXPORT_ IAlarmEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ diff --git a/inc/FSysIBatteryEventListener.h b/inc/FSysIBatteryEventListener.h index 3c0a1c8..736d24f 100644 --- a/inc/FSysIBatteryEventListener.h +++ b/inc/FSysIBatteryEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface IBatteryEventListener - * @brief This interface is the listener of the battery event. + * @brief This interface is the listener of the battery event. * * @since 2.0 * @@ -44,9 +44,11 @@ class _OSP_EXPORT_ IBatteryEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~IBatteryEventListener(void) {} @@ -55,7 +57,7 @@ public: * * @since 2.0 * - * @param[in] percentage The changed battery level + * @param[in] percentage The changed battery level * @remarks The resolution of the level is @c 5%. The range of the level is @c 0 (Minimum) to @c 100 (Maximum). */ virtual void OnBatteryLevelChangedInPercentage(int percentage) = 0; diff --git a/inc/FSysIBootEventListener.h b/inc/FSysIBootEventListener.h index fe6022a..c9e56e1 100644 --- a/inc/FSysIBootEventListener.h +++ b/inc/FSysIBootEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface IBootEventListener - * @brief This interface is the listener of the boot event. + * @brief This interface is the listener of the boot event. * * @since 2.1 * @@ -44,7 +44,9 @@ class _OSP_EXPORT_ IBootEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.1 */ diff --git a/inc/FSysIChargingEventListener.h b/inc/FSysIChargingEventListener.h index 9bfbc81..57890d4 100644 --- a/inc/FSysIChargingEventListener.h +++ b/inc/FSysIChargingEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface IChargingEventListener - * @brief This interface is the listener of the charging event. + * @brief This interface is the listener for charging events. * @since 2.0 * * The %IChargingEventListener interface must be registered and implemented by an application to @@ -44,9 +44,11 @@ class _OSP_EXPORT_ IChargingEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~IChargingEventListener(void) {} diff --git a/inc/FSysIDeviceEventListener.h b/inc/FSysIDeviceEventListener.h index 834d155..6b2d0a0 100644 --- a/inc/FSysIDeviceEventListener.h +++ b/inc/FSysIDeviceEventListener.h @@ -33,7 +33,7 @@ namespace Tizen { namespace System /** * @interface IDeviceEventListener - * @brief This interface is the listener of the device state changes. + * @brief This interface is the listener of the device state changes. * * @since 2.0 * @@ -46,7 +46,9 @@ class _OSP_EXPORT_ IDeviceEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -57,7 +59,7 @@ public: * * @since 2.0 * - * @param[in] deviceType The types of a device + * @param[in] deviceType The device type * @param[in] state The device state of type Tizen::Base::String */ virtual void OnDeviceStateChanged(DeviceType deviceType, const Tizen::Base::String& state) = 0; diff --git a/inc/FSysIRuntimeInfoGetIntAsyncResultListener.h b/inc/FSysIRuntimeInfoGetIntAsyncResultListener.h index 3a17c89..89fd757 100644 --- a/inc/FSysIRuntimeInfoGetIntAsyncResultListener.h +++ b/inc/FSysIRuntimeInfoGetIntAsyncResultListener.h @@ -31,12 +31,13 @@ namespace Tizen { namespace System { /** -* @interface IRuntimeInfoGetIntAsyncResultListener -* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class. +* @interface IRuntimeInfoGetIntAsyncResultListener +* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class. * * @since 2.0 * -* The %IRuntimeInfoGetIntAsyncResultListener interface defines the result listener for an asynchronous method call to the RuntimeInfo class. An instance of this interface is removed automatically by platform, after result is notified. +* The %IRuntimeInfoGetIntAsyncResultListener interface defines the result listener for an asynchronous method call to the +* RuntimeInfo class. An instance of this interface is removed automatically by the platform, after result is notified. * */ class _OSP_EXPORT_ IRuntimeInfoGetIntAsyncResultListener @@ -44,7 +45,8 @@ class _OSP_EXPORT_ IRuntimeInfoGetIntAsyncResultListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are when the destructor of this interface is called. * * @since 2.0 */ @@ -54,10 +56,10 @@ public: * * @since 2.0 * - * @param[in] value The @c int type runtime information - * @param[in] r An error code - * @exception E_SUCCESS The result is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The @c int type runtime information + * @param[in] r An error code + * @exception E_SUCCESS The result is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnResultReceivedForGetValueAsync(int value, result r) = 0; diff --git a/inc/FSysIRuntimeInfoGetLonglongAsyncResultListener.h b/inc/FSysIRuntimeInfoGetLonglongAsyncResultListener.h index 2e8c177..ceb7fb5 100644 --- a/inc/FSysIRuntimeInfoGetLonglongAsyncResultListener.h +++ b/inc/FSysIRuntimeInfoGetLonglongAsyncResultListener.h @@ -31,12 +31,13 @@ namespace Tizen { namespace System { /** -* @interface IRuntimeInfoGetLonglongAsyncResultListener -* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class. +* @interface IRuntimeInfoGetLonglongAsyncResultListener +* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class. * -* @since 2.0 +* @since 2.0 * -* The %IRuntimeInfoGetLonglongAsyncResultListener interface defines the result listener for an asynchronous method call to the RuntimeInfo class. An instance of this interface is removed automatically by platform, after result is notified. +* The %IRuntimeInfoGetLonglongAsyncResultListener interface defines the result listener for an asynchronous method call +* to the RuntimeInfo class. An instance of this interface is removed automatically by the platform, after result is notified. * */ class _OSP_EXPORT_ IRuntimeInfoGetLonglongAsyncResultListener @@ -44,7 +45,8 @@ class _OSP_EXPORT_ IRuntimeInfoGetLonglongAsyncResultListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -54,10 +56,10 @@ public: * * @since 2.0 * - * @param[in] value The @c long @c long type runtime information - * @param[in] r An error code - * @exception E_SUCCESS The result is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The @c long @c long type runtime information + * @param[in] r An error code + * @exception E_SUCCESS The result is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnResultReceivedForGetValueAsync(long long value, result r) = 0; diff --git a/inc/FSysIScreenEventListener.h b/inc/FSysIScreenEventListener.h index 8357610..671b805 100644 --- a/inc/FSysIScreenEventListener.h +++ b/inc/FSysIScreenEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface IScreenEventListener - * @brief This interface is the listener of the screen event. + * @brief This interface is the listener of the screen event. * * @since 2.0 * @@ -53,9 +53,11 @@ public: /** * Called when the screen turns off. @n - * Unless there is a strong reason to do otherwise, release resources (such as 3D, media, and sensors) to allow the device to enter the sleep mode to save the battery. - * Invoking a lengthy asynchronous method within this listener method can be risky, because it is not guaranteed to invoke a callback before the device enters the sleep mode. - * Similarly, do not perform lengthy operations in this listener method. All operations must be quick ones. + * Unless there is a strong reason to do otherwise, release the resources (such as 3D, media, and sensors) to allow the device + * to enter the sleep mode to save the battery. @n + * Invoking a lengthy asynchronous method within this listener method can be risky, because it is not guaranteed to invoke a + * callback before the device enters the sleep mode. Similarly, do not perform lengthy operations in this listener method. @n + * All operations must be quick ones. * *@since 2.0 */ diff --git a/inc/FSysISettingEventListener.h b/inc/FSysISettingEventListener.h index 573fd19..280494c 100644 --- a/inc/FSysISettingEventListener.h +++ b/inc/FSysISettingEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface ISettingEventListener - * @brief This interface is the listener of the setting event. + * @brief This interface is the listener of the setting event. * * @since 2.0 * @@ -44,18 +44,21 @@ class _OSP_EXPORT_ ISettingEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n This way, + * the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~ISettingEventListener(void) {} /** - * Called when a certain setting value has been changed. + * Called when a setting value has been changed. * * @since 2.0 * - * @param[in] key The key name of the changed setting information - * @remarks Invokes one of the overloaded getter methods of Tizen::System::SettingInfo to get the changed value corresponding to the given key. + * @param[in] key The key name of the changed setting information + * @remarks Invokes one of the overloaded getter methods of Tizen::System::SettingInfo to get the changed value + * corresponding to the given key. */ virtual void OnSettingChanged(Tizen::Base::String& key) = 0; diff --git a/inc/FSysISettingInfoSetValueAsyncResultListener.h b/inc/FSysISettingInfoSetValueAsyncResultListener.h index c1c5b7d..e105fed 100644 --- a/inc/FSysISettingInfoSetValueAsyncResultListener.h +++ b/inc/FSysISettingInfoSetValueAsyncResultListener.h @@ -36,7 +36,8 @@ namespace Tizen { namespace System * * @since 2.0 * - * The %ISettingInfoSetValueAsyncResultListener interface must be registered and implemented by an application to receive result for an asynchronous setting change method call. + * The %ISettingInfoSetValueAsyncResultListener interface must be registered and implemented by an application + * to receive result for an asynchronous setting change method call. * */ class _OSP_EXPORT_ ISettingInfoSetValueAsyncResultListener @@ -44,7 +45,9 @@ class _OSP_EXPORT_ ISettingInfoSetValueAsyncResultListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -55,10 +58,10 @@ public: * * @since 2.0 * - * @param[in] key The key name of the changed setting information - * @param[in] r An error code - * @exception E_SUCCESS The result is successful. - * @exception E_SYSTEM The method cannot proceed due to severe system error. + * @param[in] key The key name of the changed setting information + * @param[in] r An error code + * @exception E_SUCCESS The result is successful. + * @exception E_SYSTEM The method cannot proceed due to severe system error. */ virtual void OnResultReceivedForSetValueAsync(const Tizen::Base::String& key, result r) = 0; diff --git a/inc/FSysPowerManager.h b/inc/FSysPowerManager.h index 124fd8e..0986dbd 100644 --- a/inc/FSysPowerManager.h +++ b/inc/FSysPowerManager.h @@ -49,17 +49,19 @@ enum BatteryLevel BATTERY_LOW, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_LOW. BATTERY_CRITICAL, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_CRITICAL. BATTERY_EMPTY, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_EMPTY. - BATTERY_LEVEL_FULL = BATTERY_FULL,/**< The battery is fully charged */ - BATTERY_LEVEL_HIGH = BATTERY_HIGH,/**< The battery has plenty of charge */ - BATTERY_LEVEL_LOW = BATTERY_LOW,/**< The battery has little charge */ - BATTERY_LEVEL_CRITICAL = BATTERY_CRITICAL,/**< The battery charge is at a critical state @n It is strongly recommended to stop using all multimedia features because they are not guaranteed to work correctly at this level. */ - BATTERY_LEVEL_EMPTY = BATTERY_EMPTY, /**< The battery is empty @n It is strongly recommended to prepare for the safe termination of the application because the device will start a shutdown process soon after entering this level. */ + BATTERY_LEVEL_FULL = BATTERY_FULL, /**< The battery is fully charged */ + BATTERY_LEVEL_HIGH = BATTERY_HIGH, /**< The battery has plenty of charge */ + BATTERY_LEVEL_LOW = BATTERY_LOW, /**< The battery has little charge */ + BATTERY_LEVEL_CRITICAL = BATTERY_CRITICAL, /**< The battery charge is at a critical state @n + It is strongly recommended to stop using all multimedia features because they are not guaranteed to work correctly at this level. */ + BATTERY_LEVEL_EMPTY = BATTERY_EMPTY, /**< The battery is empty @n + It is strongly recommended to prepare for the safe termination of the application because the device will start a shutdown process soon after entering this level. */ }; /** * @enum PowerMode * - * Defines the representation of the charge remaining in the battery. + * Defines the representation of the power mode. * * @since 2.0 */ @@ -67,8 +69,8 @@ enum PowerMode { POWER_STANDBY, // This enum value is deprecated. Instead of using this enum value, use POWER_MODE_STANDBY. POWER_SLEEP, // This enum value is deprecated. Instead of using this enum value, use POWER_MODE_SLEEP. - POWER_MODE_STANDBY = POWER_STANDBY, /**< The battery is fully charged */ - POWER_MODE_SLEEP = POWER_SLEEP, /**< The battery has plenty of charge */ + POWER_MODE_STANDBY = POWER_STANDBY, /**< The standby power mode */ + POWER_MODE_SLEEP = POWER_SLEEP, /**< The sleep power mode */ }; /** @@ -93,144 +95,151 @@ public: /** * Changes the policy of the screen power management. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @return An error code - * @param[in] keepOn Set to @c true if the screen remains in the 'ON' state until the application goes to the background(inactivated), @n - * else @c false if the state of the screen is controlled by the default power control policy of the system - * @param[in] dimming Set to @c true if the screen is dimmed when there is no user input for a certain amount of time, @n - * else @c false if the screen is not dimmed - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM A system error has occurred. - * @remarks This screen power control is available only when an application is active. To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. + * @return An error code + * @param[in] keepOn Set to @c true for the screen to remain in the 'ON' state until the application goes to the background(inactivated), @n + * else @c false for the state of the screen to be controlled by the default power control policy of the system + * @param[in] dimming Set to @c true to dim the screen when there is no user input for a certain amount of time, @n + * else @c false to not dim the screen + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_SYSTEM A system error has occurred. + * @remarks The screen power control is available only when an application is active. @n + * To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. */ static result KeepScreenOnState(bool keepOn, bool dimming = true); /** * Restores the screen brightness control. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The brightness is never changed. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see SetScreenBrightness() + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The brightness is never changed. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see SetScreenBrightness() */ static result RestoreScreenBrightness(void); /** * Sets the screen brightness level for an application. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @return An error code - * @param[in] brightness The brightness level to set between @c 1 (minimum) and @c 10 (maximum). - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] brightness The brightness level to set between @c 1 (minimum) and @c 10 (maximum). + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_OUT_OF_RANGE The specified @c brightness is out of range. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks This brightness level change is available only when an application is active. To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. Even if the brightness is set to level 1, a black screen is not displayed. Level 1 is the minimum brightness level that can be set for an application. To know more about screen off, see the TurnScreenOff() method. - * @see RestoreScreenBrightness() - * @see TurnScreenOff() + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The brightness level change is available only when an application is active. @n + * To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. @n + * Even if the brightness is set to level 1, a black screen is not displayed. + * Level 1 is the minimum brightness level that can be set for an application. @n + * To know more about turning the screen off, see the TurnScreenOff() method. + * @see RestoreScreenBrightness() */ static result SetScreenBrightness(int brightness); /** * Gets the screen brightness level of an application. * - * @since 2.0 + * @since 2.0 * - * @return The brightness level of the current application - * @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. - * @remarks This method returns the screen brightness level set for an application. If the brightness level is not set, it will return the default system brightness level. @n - * In case of error, this method returns @c -1. + * @return The brightness level of the current application, @n + * else @c -1 in case of error + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @remarks + * - This method returns the screen brightness level set for an application. If the brightness level is not set, + * it will return the default system brightness level. + * - The specific error code can be accessed using the GetLastResult() method. */ static int GetScreenBrightness(void); /** * Checks whether the screen is on. * - * @since 2.0 + * @since 2.0 * - * @return @c true if the screen is on, @n - * else @c false - * @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. - * @remarks This method returns @c true when the screen is in the dimming state, and @c false in case of an error. + * @return @c true if the screen is on, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @remarks + * - This method returns @c true when the screen is in the dimming state, and @c false in case of an error. + * - The specific error code can be accessed using the GetLastResult() method. */ static bool IsScreenOn(void); /** - * Turns on the screen. + * Turns the screen on. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @return An error code - * @exception E_SUCCESS The method is successful. + * @return An error code + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. */ static result TurnScreenOn(void); /** - * Turns off the screen. + * Turns the screen off. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @return An error code - * @exception E_SUCCESS The method is successful. + * @return An error code + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. */ static result TurnScreenOff(void); /** - * Changes the policy of the CPU (Central Processing Unit) power management. + * Sets the policy of the CPU (Central Processing Unit) power management. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @return An error code + * @return An error code * @param[in] enable Set to @c true to prevent the CPU from going into sleep mode, @n - * else @c false to let the state of the CPU follow the system default power management policy - * @exception E_SUCCESS The method is successful. + * else @c false to let the state of the CPU follow the system default power management policy + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM A system error has occurred. - * @remarks This method keeps CPU power state only. Screen state or lock screen is not managed by this method. + * @exception E_SYSTEM A system error has occurred. + * @remarks This method only manages the CPU power state. The screen state or lock screen is not managed by this method. */ static result KeepCpuAwake(bool enable); /** * Sets the screen event listener. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated. @n - * Instead of using this method, use AddScreenEventListener() and RemoveScreenEventListener(). - * @since 2.0 + * Instead of using this method, use AddScreenEventListener() and RemoveScreenEventListener(). + * @since 2.0 * * @param[in] listener The screen event listener - * @remarks This method always overwrites the first element of internal IScreenEventListener list. - * The first element added by AddScreenEventListener() may be overwritten by this method, - * which may not be an expected behavior by API users. So, it is not recommended to use this method. + * @remarks This method always overwrites the first element of internal IScreenEventListener list. @n + * The first element added by AddScreenEventListener() may be overwritten by this method, + * which may not be an expected behavior by API users. So, it is not recommended to use this method. */ static void SetScreenEventListener(IScreenEventListener& listener); @@ -240,25 +249,23 @@ public: * * @since 2.1 * - * @param[in] listener The screen event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_ALREADY_EXIST The listener has already been added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see IScreenEventListener + * @param[in] listener The screen event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_ALREADY_EXIST The listener has already been added. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see RemoveScreenEventListener() */ static result AddScreenEventListener(IScreenEventListener& listener); /** - * Removes the screen event listener. + * Removes the specified screen event listener. * * @since 2.1 * - * @param[in] listener The screen event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified listener cannot be found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see IScreenEventListener + * @param[in] listener The screen event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified listener cannot be found. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see AddScreenEventListener() */ static result RemoveScreenEventListener(IScreenEventListener& listener); @@ -267,43 +274,42 @@ public: /** * Sets the charging event listener. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated. @n - * Instead of using this method, use AddChargingEventListener() and RemoveChargingEventListener(). - * @since 2.0 + * Instead of using this method, use AddChargingEventListener() and RemoveChargingEventListener(). + * @since 2.0 * * @param[in] listener The charging event listener - * @remarks This method always overwrites the first element of internal IChargingEventListener list. - * The first element added by AddChargingEventListener() may be overwritten by this method, - * which may not be an expected behavior by API users. So, it is not recommended to use this method. + * @remarks + * - This method always overwrites the first element of internal IChargingEventListener list. + * - The first element added by AddChargingEventListener() may be overwritten by this method, + * which may not be the expected behavior. So, it is not recommended to use this method. */ static void SetChargingEventListener(IChargingEventListener& listener); /** * Adds the charging event listener. * - * @since 2.1 + * @since 2.1 * - * @param[in] listener The charging event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_ALREADY_EXIST The listener has already been added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see IChargingEventListener - * @see RemoveChargingEventListener() + * @param[in] listener The charging event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_ALREADY_EXIST The listener has already been added. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see RemoveChargingEventListener() */ static result AddChargingEventListener(IChargingEventListener& listener); /** * Removes the charging event listener. * - * @since 2.1 + * @since 2.1 * - * @param[in] listener The charging event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified listener cannot be found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see IChargingEventListener - * @see AddChargingEventListener() + * @param[in] listener The charging event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified listener cannot be found. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see AddChargingEventListener() */ static result RemoveChargingEventListener(IChargingEventListener& listener); @@ -316,7 +322,7 @@ public: * @param[in] pListener The battery event listener * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @remarks If @c pListener is set to @c null, the pre-registered listener is unregistered. + * @remarks If @c pListener is set to @c null, the current listener is unregistered. */ static result SetBatteryEventListener(IBatteryEventListener* pListener); @@ -325,12 +331,13 @@ public: * * @since 2.0 * - * @return The percentage of the charge remaining in the battery. - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The resolution of the level is @c 1 percentage. The range of the level is minimum @c 0 to maximum @c 100. + * @return The percentage of the charge remaining in the battery. + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks + * - The resolution of the level is @c 1 percentage. The range of the level is minimum @c 0 to maximum @c 100. + * - The specific error code can be accessed using the GetLastResult() method. */ static int GetCurrentBatteryLevelInPercentage(void); @@ -339,25 +346,25 @@ public: * * @since 2.0 * - * @return A value from the enumerator BatteryLevel indicating the current charging level - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @return A value from the enumerator BatteryLevel indicating the current charging level + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static BatteryLevel GetCurrentBatteryLevel(void); /** * Checks whether the battery is currently charging. * - * @since 2.0 + * @since 2.0 * - * @return @c true if the charging cable is connected to the phone, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @return @c true if the charging cable is connected to the phone, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static bool IsCharging(void); @@ -367,23 +374,23 @@ public: * @since 2.1 * * @return An error code - * @param[in] listener The boot event listener - * @exception E_SUCCESS The method is successful. + * @param[in] listener The boot event listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener is already added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result AddBootEventListener(IBootEventListener& listener); /** * Removes the boot event listener. * - * @since 2.1 + * @since 2.1 * * @return An error code - * @param[in] listener The boot event listener - * @exception E_SUCCESS The method is successful. + * @param[in] listener The boot event listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener is not added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result RemoveBootEventListener(IBootEventListener& listener); diff --git a/inc/FSysRuntimeInfo.h b/inc/FSysRuntimeInfo.h index 822140d..8aeeb85 100644 --- a/inc/FSysRuntimeInfo.h +++ b/inc/FSysRuntimeInfo.h @@ -42,7 +42,8 @@ class IRuntimeInfoGetLonglongAsyncResultListener; * * @final This class is not intended for extension. * - * The %RuntimeInfo class provides runtime information, such as the allocated memory used by the application storage, memory, and CPU utilization. To get the information, you must provide the RuntimeInfo key. + * The %RuntimeInfo class provides runtime information, such as the allocated memory used by the application storage, memory, and CPU utilization. + * To get the information, you must provide the RuntimeInfo key. * * For more information on the class features, see Runtime Information. * @@ -80,49 +81,46 @@ class _OSP_EXPORT_ RuntimeInfo public: /** - * Gets the specific Tizen::Base::String type runtime information based on the specified - * designators (key). + * Gets the Tizen::Base::String type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[out] value The runtime information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[out] value The runtime information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value); /** - * Gets the specific integer type runtime information based on the specified - * designators (key). + * Gets the integer type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information @n + * @return An error code + * @param[in] key The key name of the runtime information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The integer type runtime information - * @exception E_SUCCESS The method is successful. + * @param[out] value The integer type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, int& value); /** - * Gets the specific @c long @c long type runtime information based on the specified - * designators (key). + * Gets the @c long @c long type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information @n + * @return An error code + * @param[in] key The key name of the runtime information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. @@ -130,83 +128,80 @@ public: * here. * @xmlonly @endxmlonly MaxAllocatableMemory, AvailableVideoMemory @xmlonly @endxmlonly * @endif - * @param[out] value The @c long @c long type runtime information - * @exception E_SUCCESS The method is successful. + * @param[out] value The @c long @c long type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, long long& value); /** - * Gets the specific double type runtime information based on the specified - * designators (key). + * Gets the double type runtime information based on the specified designators (key). * * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[out] value The @c double type runtime information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[out] value The @c double type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, double& value); /** - * Gets the specific @c bool type runtime information based on the specified - * designators (key). + * Gets the @c bool type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[out] value The @c bool type runtime information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[out] value The @c bool type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, bool& value); /** - * Gets the specific UuId type runtime information based on the specified - * designators (key). + * Gets the UuId type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[out] value The UuId type runtime information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[out] value The UuId type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value); /** - * Gets the specific @c long @c long type runtime information based on specified designators (key) asynchronously. + * Gets the @c long @c long type runtime information based on specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[in] listener The result listener - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValueAsync(const Tizen::Base::String& key, IRuntimeInfoGetLonglongAsyncResultListener* listener); /** - * Gets the specific @c int type runtime information based on specified designators (key) asynchronously. + * Gets the @c int type runtime information based on specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[in] listener The result listener - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValueAsync(const Tizen::Base::String& key, IRuntimeInfoGetIntAsyncResultListener* listener); diff --git a/inc/FSysSettingInfo.h b/inc/FSysSettingInfo.h index 54b7973..901debd 100644 --- a/inc/FSysSettingInfo.h +++ b/inc/FSysSettingInfo.h @@ -35,13 +35,14 @@ namespace Tizen { namespace System /** * @class SettingInfo - * @brief This class provides methods for managing setting information. + * @brief This class provides methods to manage the setting information. * * @since 2.0 * * @final This class is not intended for extension. * - * The %SettingInfo class provides methods to managing the variety user setting elements. Please refer SettingInfo key. + * The %SettingInfo class provides methods to manage the user setting elements. @n + * To get the system information, you must provide the SettingInfo key. * * For more information on the class features, see Settings Information. * @@ -80,188 +81,182 @@ class _OSP_EXPORT_ SettingInfo public: /** - * Gets the specific Tizen::Base::String type setting information based on the specified - * designators (key). + * Gets the Tizen::Base::String type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value); /** - * Gets the specific integer type setting information based on the specified - * designators (keys). + * Gets the specific integer type setting information for the specified designators (keys). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type integer - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type @c int + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, int& value); /** - * Gets the specific @c long @c long type setting information based on the specified - * designators (key). + * Gets the @c long @c long type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information + * @return An error code + * @param[in] key The key name of the setting information * @param[out] value The setting information of type @c long @c long - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, long long& value); /** - * Gets the specific double type setting information based on the specified - * designators (key). + * Gets the double type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type double - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type @c double + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, double& value); /** - * Gets the specific @c bool type setting information based on the specified - * designators (key). + * Gets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, bool& value); /** - * Gets the specific UuId type setting information based on the specified - * designators (key). + * Gets the UuId type setting information for the specified designators (key). * * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type UuId - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type UuId + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value); /** - * Checks whether specific designator(key) is supported or not. + * Checks whether specific designator(key) is supported. * - * @since 2.0 + * @since 2.0 * - * @return @c true if the key is supported, @n - * else @c false - * @param[in] key The key name of the setting information + * @return @c true if the key is supported, @n + * else @c false + * @param[in] key The key name of the setting information * */ static bool HasKey(const Tizen::Base::String& key); /** - * Sets the specific @c bool type setting information based on the specified designators (key). + * Sets the specified @c bool type setting information for the specified designators (key). * * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, bool value); /** - * Sets the specific @c int type setting information based on the specified designators (key). + * Sets the specified @c int type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type int - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c int + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, int value); /** * Sets the specific Tizen::Base::String type setting information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, Tizen::Base::String value); @@ -273,12 +268,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code - * @param[in] filePath The file path of the wallpaper - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] filePath The file path of the wallpaper + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_FILE_NOT_FOUND The entry for the specified wallpaper file or the file path cannot be found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetWallpaper(const Tizen::Base::String& filePath); @@ -291,12 +286,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code - * @param[in] filePath The file path of the ringtone - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] filePath The file path of the ringtone + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_FILE_NOT_FOUND The entry for the specified wallpaper file or the file path cannot be found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetRingtone(const Tizen::Base::String& filePath); @@ -308,14 +303,14 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] soundCategory The sound volume category - * @param[in] level The sound volume level of the designated category - * @exception E_SUCCESS The method is successful. + * @param[in] level The sound volume level of the designated category + * @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 The specified @c soundCategory is invalid. * @exception E_OUT_OF_RANGE The specified @c level is outside the bounds of @c soundCategory. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetVolume(const Tizen::Base::String& soundCategory, int level); @@ -323,116 +318,115 @@ public: * Adds the setting event listener. @n * This listener is called when a setting value is changed. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] listener The setting event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_ALREADY_EXIST The listener is already added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see RemoveSettingEventListener() + * @return An error code + * @param[in] listener The setting event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_ALREADY_EXIST The listener is already added. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see RemoveSettingEventListener() */ static result AddSettingEventListener(ISettingEventListener& listener); /** * Removes the setting event listener. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] listener The setting event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The listener is not added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see AddSettingEventListener() + * @return An error code + * @param[in] listener The setting event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The listener is not added. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see AddSettingEventListener() */ static result RemoveSettingEventListener(ISettingEventListener& listener); /** - * Gets the specific @c bool type setting information based on the specified designators (key). + * Gets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.read @n - * (%http://tizen.org/privilege/systemsetting.read is deprecated.) - * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * (%http://tizen.org/privilege/systemsetting.read is deprecated.) + * + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValueForPrivilegedKey(const Tizen::Base::String& key, bool& value); /** - * Sets the specific @c bool type setting information based on the specified designators (key). + * Sets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) - * - * @return An error code - * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * + * @return An error code + * @param[in] key The key name of the setting information + * @param[in] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid value. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueForPrivilegedKey(const Tizen::Base::String& key, bool value); /** - * Sets the specific @c bool type setting information based on the specified designators (key) asynchronously. + * Sets the @c bool type setting information for the specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @param[in] listener The result listener. - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key is existed, However it is not supported by this device. - * @exception E_IN_PROGRESS The specified key is under processing or invalid state. - * @exception E_SYSTEM Either of the following conditions has occured: - * - The method cannot proceed due to a severe system error. - * - This error can occur and Wi-Fi Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is activated.- -Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is activated. - + * @param[in] value The setting information of type @c bool + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However it is not supported by this device. + * @exception E_IN_PROGRESS The specified key is under processing or is in an invalid state. + * @exception E_SYSTEM Either of the following conditions has occured: + * - The method cannot proceed due to a severe system error. + * - Wi-Fi Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is + * activated. */ static result SetValueAsyncForPrivilegedKey(const Tizen::Base::String& key, bool value, ISettingInfoSetValueAsyncResultListener* listener); /** - * Sets the specific @c bool type setting information based on the specified designators (key) asynchronously. + * Sets the @c bool type setting information for the specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @param[in] listener The result listener. - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key is existed, However it is not supported by this device. - * @exception E_IN_PROGRESS The specified key is under processing or invalid state. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c bool + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid value. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However it is not supported by this device. + * @exception E_IN_PROGRESS The specified key is under processing or is in an invalid state. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueAsync(const Tizen::Base::String& key, bool value, ISettingInfoSetValueAsyncResultListener* listener); @@ -444,50 +438,51 @@ Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wi * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @param[in] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueForPrivilegedKey(const Tizen::Base::String& key, Tizen::Base::String value); /** - * Resets current device. @n + * Resets the current device to the default factory settings. @n * All data is removed and device is initialized. * - * @since 2.0 + * @since 2.0 * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result ResetToFactoryDefault(void); /** * @if OSPCOMPAT * @if OSPDEPREC - * Sets the setting event listener. + * Sets the specified setting event listener. * - * @deprecated This method is provided only for backward compatibility and will be deleted in the near future. Instead of using this method, it is recommended to use AddSettingEventListener() and RemoveSettingEventListener(). - * @since 2.0 + * @deprecated This method is provided only for backward compatibility and will be deleted in the near future. Instead of using this method, it is + * recommended to use AddSettingEventListener() and RemoveSettingEventListener(). + * @since 2.0 * - * @return An error code + * @return An error code * @param[in] pListener The setting event listener * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks If the value of the listener object (pListener) is @c null, the setting event listener is not called. + * @remarks If the value of the listener object (pListener) is @c null, the setting event listener is not called. * @endif * @endif */ diff --git a/inc/FSysSystemInfo.h b/inc/FSysSystemInfo.h index f917b42..5458ed9 100644 --- a/inc/FSysSystemInfo.h +++ b/inc/FSysSystemInfo.h @@ -60,7 +60,7 @@ enum SystemInfoValueType * * The %SystemInfo class provides system information, such as the API and platform versions, supported device features, * and screen dimensions. - * To get the information, you must provide the SystemInfo key. + * To get the system information, you must provide the SystemInfo key. * * For more information on the class features, see System Information. * @@ -98,195 +98,195 @@ class _OSP_EXPORT_ SystemInfo public: /** - * Gets the specific Tizen::Base::String type system information based on the specified designators (key). + * Gets the Tizen::Base::String type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The system information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. + * @param[out] value The system information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value); /** - * Gets the specific integer type system information based on the specified designators (key). + * Gets the integer type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The integer type system information - * @exception E_SUCCESS The method is successful. + * @param[out] value The integer type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, int& value); /** - * Gets the specific double type system information based on the specified designators (key). + * Gets the @c double type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information - * @param[out] value The @c double type system information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the system information + * @param[out] value The @c double type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, double& value); /** - * Gets the specific UuId type system information based on the specified designators (key). + * Gets the UuId type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information - * @param[out] value The UuId type system information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the system information + * @param[out] value The UuId type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value); /** - * Gets the specific system information based on the specified key and data type of the information. + * Gets the system information based on the specified key and data type of the information. * - * @since 2.0 + * @since 2.0 * - * @return A system information list - * @param[in] key The key name of the system information @n + * @return The system information list + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated @n * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[in] type The data type of the information - * @exception E_SUCCESS The method is successful. + * @param[in] type The data type of the information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::Collection::IList* GetValuesN(const Tizen::Base::String& key, SystemInfoValueType type); /** - * Gets the specific boolean type system information based on the specified designators (key). + * Gets the @c bool type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The @c bool type system information - * @exception E_SUCCESS The method is successful. + * @param[out] value The @c bool type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, bool& value); /** * Gets the platform version in the "[Major].[Minor].[Patch Version]" format. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code + * @return An error code * @param[out] platformVersion The platform version - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetPlatformVersion(Tizen::Base::String& platformVersion); /** - * Gets the Native API version in the "[Major].[Minor]" format. + * Gets the native API version in the "[Major].[Minor]" format. * * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code - * @param[out] nativeApiVersion The Native API version - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[out] nativeApiVersion The native API version + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetNativeApiVersion(Tizen::Base::String& nativeApiVersion); /** * Gets the WEB API version in the "[Major].[Minor]" format. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code + * @return An error code * @param[out] webApiVersion The %Tizen API version - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetWebApiVersion(Tizen::Base::String& webApiVersion); /** * Gets the platform build information. * - * @since 2.1 + * @since 2.1 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code - * @param[out] buildInfo The %Tizen build information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[out] buildInfo The %Tizen build information + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetBuildInfo(Tizen::Base::String& buildInfo); /** * Gets the International Mobile Equipment Identity (IMEI) of the device. * - * @since 2.0 + * @since 2.0 * * @privlevel partner * @privilege %http://tizen.org/privilege/systemmanager @n - * (%http://tizen.org/privilege/useridentity is deprecated.) + * (%http://tizen.org/privilege/useridentity is deprecated.) * - * @return An error code - * @param[out] imei The IMEI of the device - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[out] imei The IMEI of the device + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetImei(Tizen::Base::String& imei); diff --git a/inc/FSysSystemTime.h b/inc/FSysSystemTime.h index 20c8dba..f2dbda9 100644 --- a/inc/FSysSystemTime.h +++ b/inc/FSysSystemTime.h @@ -57,9 +57,9 @@ enum TimeMode UTC_TIME, // This enum value is deprecated. Instead of using this enum value, use UTC_TIME. STANDARD_TIME, // This enum value is deprecated. Instead of using this enum value, use STANDARD_TIME. WALL_TIME, // This enum value is deprecated. Instead of using this enum value, use TIME_MODE_WALL. - TIME_MODE_UTC = UTC_TIME, /**< The UTC Time */ - TIME_MODE_STANDARD = STANDARD_TIME, /**< The Standard Time */ - TIME_MODE_WALL = WALL_TIME, /**< The Wall Time */ + TIME_MODE_UTC = UTC_TIME, /**< The UTC Time */ + TIME_MODE_STANDARD = STANDARD_TIME, /**< The Standard Time */ + TIME_MODE_WALL = WALL_TIME, /**< The Wall Time */ }; class _OSP_EXPORT_ SystemTime @@ -94,7 +94,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] timeMode The time mode @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL + * @param[in] timeMode The time mode which can be @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL * @param[out] currentTime The current system time * @exception E_SUCCESS The method is successful. */ @@ -118,13 +118,13 @@ public: * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * * @return An error code - * @param[in] currentTime The current system time in UTC - * @exception E_SUCCESS The method is successful. + * @param[in] currentTime The current system time in UTC + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetCurrentTime(const Tizen::Base::DateTime& currentTime); private: diff --git a/inc/FSysVibrator.h b/inc/FSysVibrator.h index 33463c3..c29f120 100644 --- a/inc/FSysVibrator.h +++ b/inc/FSysVibrator.h @@ -35,7 +35,7 @@ namespace Tizen { namespace System * * @since 2.0 * - * The %Vibrator class handles the vibration functionality of a device. It allows you to manage the device's vibrator parameters, such as vibration count and level. + * The %Vibrator class handles the vibration functionality of a device. It allows the management of the device's vibrator parameters, such as the vibration count and level. * * For more information on the class features, see Vibrator Management. * @@ -84,23 +84,23 @@ namespace Tizen { namespace System /** * @struct IntensityDurationVibrationPattern - * @brief This struct has the specified duration and a vibration intensity level. + * @brief This struct represents the specified duration and vibration intensity level. * - * The %IntensityDurationVibrationPattern struct has the specified duration and a vibration intensity level. This can be used with Vibrator::Start(IntensityDurationVibrationPattern[] patterns, int length, int repeatCount) as a custom pattern. + * The %IntensityDurationVibrationPattern struct represents the specified duration and vibration intensity level. This struct can be used with Vibrator::Start(IntensityDurationVibrationPattern[] patterns, int length, int repeatCount) as a custom pattern. * * @since 2.1 */ struct _OSP_EXPORT_ IntensityDurationVibrationPattern { - int duration; /**< The duration in milliseconds when the vibrator is on @n - * The @c duration is not allowed a negative value. - */ + int duration; /**< The duration in milliseconds when the vibrator is on @n + * The @c duration does not allow a negative value. + */ int intensity; /**< The vibration intensity [@c -1~ @c 100]: @n - * @li The system default vibration intensity (-1) - * @li The silent vibration intensity (0) - * @li The minimum vibration intensity (1) - * @li The maximum vibration intensity (100) - */ + * @li The system default vibration intensity (-1) + * @li The silent vibration intensity (0) + * @li The minimum vibration intensity (1) + * @li The maximum vibration intensity (100) + */ }; @@ -110,11 +110,11 @@ class _OSP_EXPORT_ Vibrator public: /** - * This is the default constructor for this class. - * + * This is the default constructor for this class. @n + * The object is not fully constructed after this constructor is called. + * For full construction, the Construct() method must be called right after calling this constructor. * @since 2.0 * - * @remarks The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. */ Vibrator(void); @@ -142,27 +142,28 @@ public: /** - * Vibrates the device with a specified array pattern that has vibration intensity and duration. @n + * Vibrates the device with a specified array pattern that has a vibration intensity and duration. @n * The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs. @n - * If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately. @n + * If this method is called again before the previous vibration stops, the previous vibration is cancelled and the new vibration starts immediately. @n * If a new vibrator instance triggers the vibration, the vibrator merges the previous vibration pattern with the new one in the overlapped time. @n - * If the system alert occurs such as ring vibration and a system event notification, the vibration can be interrupted. @n - * If the application is terminated, the vibration is canceled. + * If a system alert occurs such as a ring vibration or a system event notification, the vibration can be interrupted. @n + * If the application is terminated, the vibration is cancelled. * * @since 2.1 - * @privlevel public + * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * * @return An error code * - * @param[in] patterns An array of @c IntensityDurationVibrationPattern - * @param[in] length The length of @c patterns - * @param[in] repeatCount The number of times the pattern repeats @n This value must be between @c 1 to @c 100. - * @exception E_SUCCESS The method is successful. + * @param[in] patterns The array of @c IntensityDurationVibrationPattern + * @param[in] length The length of @c patterns + * @param[in] repeatCount The number of times the pattern repeats @n + * This value must be between @c 1 to @c 100. + * @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. - * @exception E_OPERATION_FAILED The device operation has failed. - * @remarks The vibration intensity does not apply the change, even if the system default vibration intensity is changed after starting vibration. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OPERATION_FAILED The device operation has failed. + * @remarks The vibration intensity does not apply the change, even if the system default vibration intensity is changed after starting the vibration. * @see IntensityDurationVibrationPattern */ result Start(IntensityDurationVibrationPattern* patterns, int length, int repeatCount = 1); @@ -170,61 +171,66 @@ public: /** * Vibrates the device with the specified pattern and level. @n * 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. + * If this method is called again before the previous vibration stops, the previous vibration is cancelled and the new vibration starts immediately. * - * @brief [Deprecated] - * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int). + * @brief [Deprecated] + * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int). * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * * @return An error code - * @param[in] onPeriod The period in milliseconds when the vibrator is on @n - * It should be greater than @c 0. - * @param[in] offPeriod The period in milliseconds when the vibrator is off @n - * It should be equal to or greater than @c 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. + * @param[in] onPeriod The period in milliseconds when the vibrator is on @n + * It should be greater than @c 0. + * @param[in] offPeriod The period in milliseconds when the vibrator is off @n + * It should be equal to or greater than @c 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 + * It 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. * @exception E_DEVICE_BUSY The device cannot be approached because of other operations. * @exception E_DEVICE_FAILED The device operation has failed. - * @remarks Various devices may have different vibration capabilities. - * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. - * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n - * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is greater than the limit. + * @remarks Various devices may have different vibration capabilities. @n + * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. @n + * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, + * value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in + * intermediate vibration levels. @n + * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is + * greater than the limit. * */ result Start(long onPeriod, long offPeriod, int count, int level = 0); /** - * Vibrates the device for the specified duration at the specified @c level. @n + * Vibrates the device for the specified duration at the specified level. @n * 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. + * If this method is called again before the previous vibration stops, the previous vibration is cancelled and the new vibration starts immediately. * - * @brief [Deprecated] - * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int). + * @brief [Deprecated] + * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int). * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * * @return An error code - * @param[in] milliseconds The duration for the vibration in milliseconds @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. - * @exception E_SUCCESS The method is successful. + * @param[in] milliseconds The duration for the vibration in milliseconds @n + * It should be greater than @c 0. + * @param[in] level The vibration level @n + * It 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. * @exception E_DEVICE_BUSY The device cannot be approached because of other operations. * @exception E_DEVICE_FAILED The device operation has failed. * @remarks Various devices have different vibration capabilities. @n - * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. - * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n - * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is greater than the limit. + * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. @n + * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest + * frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n + * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is + * greater than the limit. * */ result Start(long milliseconds, int level = 0); @@ -232,7 +238,7 @@ public: /** * Turns the vibrator off. * - * @since 2.0 + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * diff --git a/inc/FSystem.h b/inc/FSystem.h index aada397..e61d108 100644 --- a/inc/FSystem.h +++ b/inc/FSystem.h @@ -66,11 +66,11 @@ namespace Tizen { /** * @namespace Tizen::System - * @brief This namespace contains classes and interfaces for %System. - * @since 2.0 + * @brief This namespace contains classes and interfaces for %System. + * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %System namespace provides system management features, such as system time, alarm, vibrator, power, and device management. * It also provides the system, setting, and runtime information. diff --git a/inc/FText.h b/inc/FText.h index 6e1236e..33695bc 100644 --- a/inc/FText.h +++ b/inc/FText.h @@ -38,18 +38,19 @@ /** * @namespace Tizen::Text - * @brief This namespace contains classes that encode and decode characters. + * @brief This namespace contains classes that encode and decode characters. * * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library: @b osp-appfw + * @b Library: @b osp-appfw * - * The %Text namespace contains the Encoding class, which is the base class for encoding and decoding many character encodings, such as UTF-8, UCS-2, Latin-1, GSM, and ASCII. It also contains the Decoder and Encoder classes for converting text blocks. The main purpose of this namespace is to support inter- + * + * The %Text namespace contains the Encoding class, which is the base class for encoding and decoding different character encodings, such as UTF-8, UCS-2, Latin-1, GSM, and ASCII. + * It also contains the Decoder and Encoder classes for converting text blocks. The main purpose of this namespace is to support inter- * operability between the various existing languages and scripts. * %Text is a data consisting of a sequence of characters. - * It is also defined as a series of characters that can be displayed on a - * display terminal or printed on paper for human reading. + * It is also defined as a series of characters that can be displayed on a display terminal or printed on a paper for human reading. * * For more information on the %Text namespace features, see Text Guide. * diff --git a/inc/FTextAsciiEncoding.h b/inc/FTextAsciiEncoding.h index 64d2ab0..82f7492 100644 --- a/inc/FTextAsciiEncoding.h +++ b/inc/FTextAsciiEncoding.h @@ -109,9 +109,9 @@ public: * @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 and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * 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 * @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 empty or invalid. @@ -128,9 +128,9 @@ public: * @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 and the starting position is zero. - * @param[in] str A string to encode + * 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] 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 empty or invalid. @@ -147,21 +147,25 @@ public: * @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[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] 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[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 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_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 GetChars() */ @@ -174,22 +178,26 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A 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 - * @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_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @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 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() */ virtual result GetBytes(const Tizen::Base::String& str, int charIndex, int charCount, @@ -203,9 +211,9 @@ public: * @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 + * 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 * @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 empty or invalid. @@ -224,84 +232,93 @@ 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 string is stored - * @param[in] charIndex The index from where 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 or @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 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. + * @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 string 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 Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes or @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 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() */ virtual result GetChars(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @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. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @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 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 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. + * @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 the multiple byte arrays, use the Decoder class, which maintains state consistency + * between multiple calls. * @see GetBytesN() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @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] 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. - * @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. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @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. + * @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_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. - * @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. + * @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() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, int index, int count, Tizen::Base::String& str) const; /** - * Gets the maximum number of bytes required for encoding a given number of characters. + * Gets the maximum number of bytes required for encoding the given number of characters. * * @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 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 bytes required for encoding the given number of characters + * @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 Encoding::GetByteCount() */ virtual int GetMaxByteCount(int charCount) const; @@ -311,11 +328,10 @@ public: * @since 2.0 * * @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 This method determines an appropriate buffer size for character arrays passed to - * GetChars() or a decoder for encoding. - * @see Encoding::GetCharCount() - * @see GetChars() + * @param[in] byteCount The total number of bytes to encode + * @remarks This method determines an appropriate buffer size for character arrays passed to + * GetChars() or a decoder for encoding. + * @see Encoding::GetCharCount() */ virtual int GetMaxCharCount(int byteCount) const; @@ -325,11 +341,11 @@ 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 the appropriate state between the conversions. @n - * At present, only the Utf8Encoding class supports this method. Other classes return @c null. - * @see GetBytes() + * @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 the appropriate state between the conversions. + * - At present, only the Utf8Encoding class supports this method. Other classes return @c null. */ virtual Encoder* GetEncoderN(void) const; @@ -338,12 +354,11 @@ 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 the appropriate state between the conversions. @n - * At present, only the Utf8Encoding class supports this method. Other classes return @c null. - * - * @see GetChars() + * @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 the appropriate state between the conversions. + * - At present, only the Utf8Encoding class supports this method. Other classes return @c null. */ virtual Decoder* GetDecoderN(void) const; @@ -352,7 +367,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/inc/FTextDecoder.h b/inc/FTextDecoder.h index 4761a0c..fa1ee1b 100644 --- a/inc/FTextDecoder.h +++ b/inc/FTextDecoder.h @@ -38,7 +38,7 @@ namespace Tizen { namespace Text * * 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() and enables it to decode a sequence of bytes that span adjacent blocks. * * For more information on the class features, see Converting Text Data in Separate Blocks. * @@ -62,20 +62,23 @@ 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[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] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer 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[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] 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_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 specified string contains code points that are outside the bounds of the character encoding scheme. + * @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. * @see Encoder::GetByteCount() */ virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, @@ -89,13 +92,14 @@ 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 in the buffer 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 + * @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_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. * @see Encoder::GetBytesN() @@ -110,23 +114,27 @@ 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 in the buffer 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] 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. + * @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[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_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::WcharBuffer 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::WcharBuffer instance is not terminated by a @c null character. * @see Encoder::GetBytesN() */ virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, diff --git a/inc/FTextEncoder.h b/inc/FTextEncoder.h index 26e4d0c..9282be0 100644 --- a/inc/FTextEncoder.h +++ b/inc/FTextEncoder.h @@ -38,7 +38,7 @@ namespace Tizen { namespace Text * * 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 Converting Text Data in Separate Blocks. @@ -62,19 +62,22 @@ public: * @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() */ @@ -87,15 +90,16 @@ public: * @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() @@ -108,24 +112,28 @@ public: * @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, diff --git a/inc/FTextEncoding.h b/inc/FTextEncoding.h index f08c8d2..e12bec2 100644 --- a/inc/FTextEncoding.h +++ b/inc/FTextEncoding.h @@ -117,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. @@ -131,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. @@ -150,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. @@ -174,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. @@ -193,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. @@ -210,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() @@ -235,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() */ @@ -262,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. @@ -278,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. @@ -302,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. @@ -319,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() */ @@ -347,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() @@ -362,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() @@ -386,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; @@ -400,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; @@ -410,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; @@ -423,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; @@ -435,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); @@ -499,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. + * 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); @@ -518,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); @@ -528,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. @@ -541,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() @@ -565,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 @@ -573,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() diff --git a/inc/FTextGsmEncoding.h b/inc/FTextGsmEncoding.h index 3e3a881..9a04639 100644 --- a/inc/FTextGsmEncoding.h +++ b/inc/FTextGsmEncoding.h @@ -108,10 +108,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode - * @param[out] byteCount The total number of bytes 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 empty. + * @param[in] str The string to encode + * @param[out] byteCount The total number of bytes required to encode the specified string + * @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 str 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 string is encoded. @@ -125,10 +127,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 + * @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. + * @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 is encoded. @@ -142,14 +146,20 @@ public: * @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[out] byteCount The total number of bytes required to encode the specified range of characters + * @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[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. + * @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 is encoded. @@ -164,14 +174,15 @@ 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 + * 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 * @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. * @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 GetCharsN() */ virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars) const; @@ -184,13 +195,14 @@ 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] str A 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 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. - * @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 GetString() */ virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::String& str) const; @@ -202,18 +214,26 @@ public: * @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] 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[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_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @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 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 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() */ @@ -227,17 +247,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A 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() */ @@ -250,13 +278,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @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_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 decoded. + * @remarks This method determines the total number of characters that are generated when the specified range of bytes are decoded. * @see GetMaxCharCount() */ virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int& charCount) const; @@ -267,14 +296,20 @@ 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] 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_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. + * @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] 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 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 decoded. @@ -289,8 +324,8 @@ 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 + * 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 * @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. @@ -307,17 +342,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 or @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 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 or @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 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() */ @@ -325,38 +368,46 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @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. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @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 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() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @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] 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[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @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. * @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 parmater 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() */ @@ -395,11 +446,11 @@ 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 the appropriate state between the conversions. - * Currently only UTF-8 encoding supports this method. The other classes return a value of @c null. - * @see GetBytes() + * @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 the 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; @@ -408,11 +459,11 @@ 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 the appropriate state between the conversions. - * Currently only UTF-8 encoding supports this method. The other classes return a value of @c null. - * @see GetChars() + * @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 the 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; @@ -421,7 +472,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/inc/FTextLatin1Encoding.h b/inc/FTextLatin1Encoding.h index d24dbae..f999190 100644 --- a/inc/FTextLatin1Encoding.h +++ b/inc/FTextLatin1Encoding.h @@ -42,8 +42,8 @@ namespace Tizen { namespace Text * though the two are not identical. * Latin1 also serves as the basis for the ANSI character set of MS Windows. * Only the characters in ISO Latin-1 are guaranteed to be supported on an Internet website. - * When a %Web browser, such as Internet Explorer or Firefox formats a %Web page on a client system, such as - * Windows, it maps the ISO Latin-1 characters as best it can into the default character set. + * When a %Web browser, such as Internet Explorer or Firefox formats a Web page on a client system, such as + * Windows, it maps the ISO Latin-1 characters to the default character set in the best possible way. * * For more information on the class features, see Converting All Text Data at Once. * @@ -110,9 +110,9 @@ public: * * @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 and the starting position is zero. + * @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 * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -128,10 +128,10 @@ public: * * @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 and the starting position is zero. - * @param[in] str A string to encode + * @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] 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 empty or invalid. @@ -149,20 +149,24 @@ 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] 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 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_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() @@ -177,21 +181,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A 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[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 + * @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 parmater 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() */ @@ -203,9 +211,9 @@ public: * * @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. + * @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 * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -224,20 +232,24 @@ 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] 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] 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 or @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 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 or @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 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() */ @@ -245,7 +257,7 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * @@ -255,32 +267,36 @@ 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() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @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] 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[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @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. * @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() */ @@ -292,9 +308,9 @@ public: * * @since 2.0 * - * @return The maximum number of bytes required for encoding a given number of characters + * @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 This method 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() */ virtual int GetMaxByteCount(int charCount) const; @@ -305,9 +321,9 @@ public: * * @since 2.0 * - * @return The maximum number of characters generated by decoding the specified number of bytes + * @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 This method 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::GetByteCount() */ @@ -319,11 +335,11 @@ 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 the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * @see GetBytes() + * @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 the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Encoder* GetEncoderN(void) const; @@ -333,10 +349,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 the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * @see GetChars() + * @remarks + * - Contrary to GetChars(), a decoder can convert partial sequences of bytes + * into partial sequences of characters by maintaining the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Decoder* GetDecoderN(void) const; @@ -345,7 +361,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/inc/FTextUcs2Encoding.h b/inc/FTextUcs2Encoding.h index 1af58d9..ed744bb 100644 --- a/inc/FTextUcs2Encoding.h +++ b/inc/FTextUcs2Encoding.h @@ -110,11 +110,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode + * @param[in] str The string to encode * @param[out] byteCount The total number of bytes required to encode the 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 exact number of bytes * that are produced if the given string is encoded. @@ -131,8 +132,9 @@ public: * @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. + * @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 exact number of bytes * that are produced if the given array of characters is encoded. @@ -146,17 +148,20 @@ public: * @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[out] byteCount The total number of bytes required to encode the specified range of characters + * @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[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. + * @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 inout 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 exact number of bytes * that are produced if the given array of characters is encoded. @@ -170,9 +175,9 @@ public: * * @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 and the starting position is zero. + * @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 * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -188,11 +193,11 @@ public: * * @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 and the starting position is zero. - * @param[in] str A string to encode - * @exception E_SUCCESS The method is successful. + * @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] 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 empty or invalid. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. @@ -210,19 +215,23 @@ 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] 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] 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 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_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 a Tizen::Base::WcharBuffer into a range of bytes in a Tizen::Base::ByteBuffer. * @see GetChars() @@ -237,21 +246,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A 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[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. + * @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 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() */ @@ -265,10 +278,11 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance + * @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_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 exact number of characters * that are produced if the given range of bytes is converted. @@ -283,16 +297,19 @@ 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 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_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 exact number of characters * that are produced if the given range of bytes is converted. @@ -301,14 +318,14 @@ public: virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, int& charCount) const; /** - *Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer. + * Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer. * * @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 + * @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 * @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 empty or invalid. @@ -326,20 +343,24 @@ 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] 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] 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 or @ 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 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 or @ 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 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() */ @@ -347,42 +368,46 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @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_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() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @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. - * @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. + * 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 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 GetBytesN() */ @@ -390,15 +415,14 @@ public: /** - * Gets the maximum number of bytes required for encoding a given number of characters. + * Gets the maximum number of bytes required for encoding the given number of characters. * * @since 2.0 * * @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 This method 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() */ virtual int GetMaxByteCount(int charCount) const; @@ -410,10 +434,9 @@ public: * * @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 This method determines an appropriate buffer size for the character arrays passed to - * GetChars() or a decoder for encoding. + * @remarks This method determines an appropriate buffer size for the character arrays passed to + * GetChars() or a decoder for encoding. * @see GetByteCount() - * @see GetChars() */ virtual int GetMaxCharCount(int byteCount) const; @@ -423,11 +446,11 @@ 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 the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * @see GetBytes() + * @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 the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Encoder* GetEncoderN(void) const; @@ -437,12 +460,11 @@ 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 the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * - * @see GetChars() + * @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 the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Decoder* GetDecoderN(void) const; @@ -451,7 +473,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/inc/FTextUtf8Decoder.h b/inc/FTextUtf8Decoder.h index cf0e220..cb0ee6f 100644 --- a/inc/FTextUtf8Decoder.h +++ b/inc/FTextUtf8Decoder.h @@ -39,8 +39,8 @@ namespace Tizen { namespace Text * * 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 Converting Text Data in Separate Blocks. * @@ -124,19 +124,22 @@ 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 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; @@ -145,17 +148,18 @@ public: * * @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; @@ -164,27 +168,30 @@ public: * 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; diff --git a/inc/FTextUtf8Encoder.h b/inc/FTextUtf8Encoder.h index fecb8e7..b1969b6 100644 --- a/inc/FTextUtf8Encoder.h +++ b/inc/FTextUtf8Encoder.h @@ -41,8 +41,8 @@ namespace Tizen { namespace Text * * The %Utf8Encoder class converts the blocks of characters into encoded blocks of bytes. * Universal Transformation Format-8 (UTF-8) is a translated language that is used on the internet. It converts the - * unicode into 8-bit bytes. @n UTF-8 encoding supports all unicode character values and surrogates. - * Note that %Utf8Encoder is not used in reality, because keeping the internal state of encoding from unicode + * Unicode into 8-bit bytes. @n UTF-8 encoding supports all Unicode character values and surrogates. + * Note that %Utf8Encoder is not used in reality, because keeping the internal state of encoding from Unicode * to UTF-8 can be avoided if the translation unit is even. * This means that the real implementation of %Utf8Encoder is the same as that of Utf8Encoding in this state. * @@ -129,19 +129,22 @@ public: * @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 + * @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 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, or + * - 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 Utf8Decoder::GetCharCount() */ @@ -153,16 +156,17 @@ public: * * @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 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 + * @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] 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_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 Utf8Decoder::GetCharsN() @@ -174,25 +178,29 @@ public: * * @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 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 + * @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 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 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 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 Utf8Decoder::GetCharsN() */ virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars, int charIndex, int charCount, diff --git a/inc/FTextUtf8Encoding.h b/inc/FTextUtf8Encoding.h index f797162..eba0eb3 100644 --- a/inc/FTextUtf8Encoding.h +++ b/inc/FTextUtf8Encoding.h @@ -106,7 +106,7 @@ public: virtual ~Utf8Encoding(void); /** - * Gets the total number of bytes that are generated by encoding an instance of specified string. @n + * Gets the total number of bytes that are generated by encoding an instance of the specified string. @n * The %GetByteCount() method determines the total number of bytes that are generated when the specified string is encoded. * * @since 2.0 @@ -115,8 +115,9 @@ public: * @param[in] str The string to encode * @param[out] byteCount The total number of bytes required to encode the 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. * @see GetMaxByteCount() */ @@ -130,12 +131,13 @@ 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. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @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. * @see GetMaxByteCount() */ virtual result GetByteCount(const Tizen::Base::WcharBuffer& chars, int& byteCount) const; @@ -148,16 +150,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[out] byteCount The total number of bytes required to encode the specified range of characters + * @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 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. * @see GetMaxByteCount() */ @@ -168,13 +173,13 @@ public: * * @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 and the starting position is zero. - * @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 empty or invalid. + * @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 + * @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 empty or invalid. * @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 GetCharsN() @@ -186,14 +191,15 @@ public: * * @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 and the starting position is zero. - * @param[in] str A string to encode - * @exception E_SUCCESS The method is successful. + * @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] 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 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 The specific error code can be accessed using the GetLastResult() method. * @see GetString() @@ -208,20 +214,24 @@ 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] 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_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 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 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. * @see GetChars() */ @@ -235,22 +245,26 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A 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[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_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @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 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() */ virtual result GetBytes(const Tizen::Base::String& str, int charIndex, int charCount, @@ -267,8 +281,9 @@ public: * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @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_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 GetMaxCharCount() */ @@ -283,16 +298,19 @@ 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 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_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. + * @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 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. * @see GetMaxCharCount() */ @@ -303,14 +321,14 @@ public: * * @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 position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @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 position is zero. + * @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 empty or invalid. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @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 GetBytesN() */ @@ -324,20 +342,24 @@ 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] 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] 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 or @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 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 or @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 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() */ @@ -345,42 +367,46 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer 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_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() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @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. * @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() */ @@ -388,15 +414,14 @@ public: /** - * Gets the maximum number of bytes required for encoding a given number of characters. + * Gets the maximum number of bytes required for encoding the given number of characters. * * @since 2.0 * - * @return The maximum number of bytes required for encoding a given number of characters + * @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 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; @@ -406,12 +431,11 @@ public: * * @since 2.0 * - * @return The maximum number of characters generated by decoding the specified number of bytes - * @param[in] byteCount The total number of bytes to encode + * @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 This method determines an appropriate buffer size for the character arrays passed to * GetChars() or a decoder for encoding. * @see GetCharCount() - * @see GetChars() */ virtual int GetMaxCharCount(int byteCount) const; @@ -420,10 +444,9 @@ public: * * @since 2.0 * - * @return A pointer to the Encoder instance for the current encoding + * @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 the appropriate states between the conversions. - * @see GetBytes() */ virtual Encoder* GetEncoderN(void) const; @@ -432,10 +455,9 @@ public: * * @since 2.0 * - * @return A pointer to the Decoder instance for the current encoding + * @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 the appropriate states between the conversions. - * @see GetChars() */ virtual Decoder* GetDecoderN(void) const; @@ -444,7 +466,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; -- 2.7.4