X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFLclCalendar.h;h=9f8c21699271203722c04e234330c82ef551ef55;hb=376b1791f5888970901326fa60f67431fa701a4d;hp=d896a02867d8e2734fa3854d64cce72b1b0e4f2d;hpb=90fa7aa7bcf38cf05b7095750cf6d7f0b678e4fd;p=platform%2Fframework%2Fnative%2Fappfw.git
diff --git a/inc/FLclCalendar.h b/inc/FLclCalendar.h
index d896a02..9f8c216 100644
--- a/inc/FLclCalendar.h
+++ b/inc/FLclCalendar.h
@@ -1,5 +1,4 @@
//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
@@ -89,7 +88,7 @@ enum TimeField
TIME_FIELD_YEAR, /**< Year : 1-based */
TIME_FIELD_MONTH, /**< Month : 1-based (1~13)*/
TIME_FIELD_WEEK_OF_YEAR, /**< Week of Year : 1-based (1~53) */
- TIME_FIELD_WEEK_OF_MONTH, /**< Week of Month : 1-based (1~5, may be specified as 0) */
+ TIME_FIELD_WEEK_OF_MONTH, /**< Week of Month : 1-based (1~6, may be specified as 0) */
TIME_FIELD_DAY_OF_MONTH, /**< Date : 1-based (1~31) */
TIME_FIELD_DAY_OF_YEAR, /**< Day of Year : 1-based (1~366) */
TIME_FIELD_DAY_OF_WEEK, /**< Day of Week : 1-based (1~7) */
@@ -102,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
@@ -118,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.
@@ -130,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 compatibile 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. @n
+ * @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
*/
@@ -181,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 compatibile 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. @n
+ * @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.
@@ -223,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 compatibile 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. @n
+ * @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
*
@@ -272,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
*
@@ -289,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;
@@ -303,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 compatibile 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. @n
+ * @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
@@ -348,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.
@@ -408,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
*
@@ -462,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.
*/
@@ -493,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;
@@ -508,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.
*/
@@ -522,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.
*/
@@ -536,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.
*/
@@ -550,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.
*/
@@ -575,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;
@@ -586,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;
@@ -602,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;
@@ -616,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;
@@ -627,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;
@@ -637,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;
@@ -670,16 +673,15 @@ public:
/**
* Creates an instance of %Calendar of the specified type with the 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 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.
@@ -690,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.
@@ -709,28 +711,27 @@ public:
/**
* Creates an instance of %Calendar of the specified type with the specified @c locale and the GMT time zone. @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 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 compatibile 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);
@@ -738,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 compatibile 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. @n
- * @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
*/
@@ -796,7 +797,7 @@ protected:
/**
* @enum CalendarLimitType
*
- * Defines the calendar limitations.
+ * Defines the calendar limits.
*
* @since 2.0
*/
@@ -818,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 compatibile 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. @n
- * @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;
@@ -921,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.
*/
@@ -930,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;
@@ -965,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
*
@@ -979,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
@@ -1053,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
*/