* @final This class is not intended for extension.
*
* The %Recurrence class provides methods to access the information of a %Recurrence.
- * A CalEvent can be made a recurring event using this class. To set or get the information of a recurrence (such as start time and recurrence
- * pattern) use the methods of this class. The recurrence date is the start date of the CalEvent, if they do not match.
+ * A CalEvent can be made a recurring event using this class. To set or get the information of a recurrence (such as the start time and recurrence
+ * pattern) use the methods of this class. The recurrence date is the start date of the %CalEvent, if they do not match.
*
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/social/recurrence_reminder_sensitivity.htm">Recurrence, Reminder, and Sensitivity Properties of Calendar Items</a>.
*
* @since 2.0
*
- * @param[in] rhs An instance of %Recurrence
+ * @param[in] rhs An instance of %Recurrence to copy
*/
Recurrence(const Recurrence& rhs);
virtual ~Recurrence(void);
/**
- * Compares the input Tizen::Base::Object with the calling %Recurrence instance.
+ * Compares the specified Tizen::Base::Object with the current %Recurrence instance.
*
* @since 2.0
*
- * @return @c true if the input object equals the calling %Recurrence instance, @n
+ * @return @c true if the specified object equals the current %Recurrence instance, @n
* else @c false
- * @param[in] rhs The object instance to compare with the calling object
+ * @param[in] rhs The object instance to compare with the current object
* @see GetHashCode()
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
*
* @since 2.0
*
- * @return An integer value representing the recurrence interval, @n
+ * @return The integer value that represents the recurrence interval, @n
* else @c 1 if this property is not set
*/
int GetInterval(void) const;
/**
- * Gets the end date and time of recurrence.
+ * Gets the end date and time of the recurrence.
*
* @since 2.0
*
- * @return An instance of Tizen::Base::DateTime representing the end date and time
+ * @return An instance of Tizen::Base::DateTime that represents the end date and time
* @remarks If this method returns @c null, get the recurrence counts using the GetCounts() method.
*
*/
*
* @since 2.0
*
- * @return An integer value representing the number of recurrences
+ * @return The integer value that represents the number of recurrences
* @remarks If this method returns @c 0, get the recurrence end date and time using the GetUntil() method.
*
*/
*
* @since 2.0
*
- * @return An integer value representing the first day of the week
+ * @return The integer value that represents the first day of the week
*
*/
CalDayOfWeek GetWeekStart(void) const;
*
* @since 2.0
*
- * @return An integer value representing the CalDayofWeek
+ * @return The integer value that represents the CalDayofWeek
* @remarks The Frequency property must be obtained. If the frequency is #FREQ_WEEKLY, the return value may be a combination of days,
* like #CAL_MONDAY| #CAL_THURSDAY.
*
*
* @since 2.0
*
- * @return An integer value between @c 1 ~ @c 31 representing the day of a month
+ * @return The integer value between @c 1 and @c 31 that represents the day of the month
* @remarks The Frequency property must be obtained.
*/
int GetDayOfMonth(void) const;
*
* @since 2.0
*
- * @return An integer value between @c 1 ~ @c 5 representing the week of a month
+ * @return The integer value between @c 1 and @c 5 that represents the week of the month
* @remarks The Frequency property must be obtained.
*
*/
*
* @since 2.0
*
- * @return An integer value between @c 1 ~ @c 12 representing the month of a year
+ * @return The integer value between @c 1 and @c 12 that represents the month of the year
* @remarks The Frequency property must be obtained.
*
*/
/**
* Sets a recurring frequency type among specific types (daily, weekly, monthly, and yearly). @n
- * This property must be set before setting the day of recurrence. After setting the frequency, other properties are reset to default values. @n
- * For weekly, the day of week must be set. @n
+ * This property must be set before setting the day of the recurrence. After setting the frequency, other properties are reset to default values. @n
+ * For weekly, the day of the week must be set. @n
* For monthly, the day of the week and the week of the month must be set. @n
* For yearly, either the day of the month and the month of the year, or the day of the week, the week of the month, and the month of the year must be set.
*
/**
* Sets the interval of recurrence. @n
- * If the frequency is weekly and the recurrence interval is set to 2, the event occurs every two weeks.
+ * If the frequency is weekly and the recurrence interval is set to @c 2, the event occurs every two weeks.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @page CompRecurrenceSetIntervalPage Compatibility for SetInterval()
* @section CompRecurrenceSetIntervalPageIssueSection Issues
* Implementing this method in OSP compatible applications has the following issues: @n
- * -# If the value of the interval to be set is greater than 255, E_INVALID_ARG is returned.
+ * -# If the value of the interval to be set is greater than @c 255, @c E_INVALID_ARG is returned.
*
* @section CompRecurrenceSetIntervalPageSolutionSection Resolutions
* This issue has been resolved in Tizen. @n
* @since 2.0
*
* @return An error code
- * @param[in] pUntil The end date and time
- * @exception E_SUCCESS The method is successful.
+ * @param[in] pUntil The end date and time
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c pUntil is out of the valid range. @n
- * The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
+ * The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @remarks Either the until or count properties may be set. @n
* When the until property is set, the count property becomes @c 0. @n
* When the count property is set, the until property becomes @c null.
* Sets the first day of the week. @n
* The default value is set to #CAL_MONDAY. The valid values are #CAL_SUNDAY and #CAL_MONDAY. @n
* This value is very important when the recurrence type is weekly and the interval is greater than @c 1. @n
- * The weekly recurrence rule will be calculated based on the week start value.
+ * The weekly recurrence rule is calculated based on the week's start value.
*
* @since 2.0
*
* @return An error code
* @param[in] weekStart The day on which the week starts
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c day is invalid.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c weekStart is invalid.
*/
result SetWeekStart(CalDayOfWeek weekStart);
* @since 2.0
*
* @return An error code
- * @param[in] day An integer value representing the day of the week
+ * @param[in] day The integer value that represents the day of the week
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c day is invalid.
* @exception E_TYPE_MISMATCH The #RecurFrequency is not #FREQ_WEEKLY, #FREQ_MONTHLY, or #FREQ_YEARLY.
* Sets the day of the month which indicates when the event recurs. @n
* The Frequency property must be set before setting this property. @n
* This property is valid for the following #RecurFrequency enumeration types: #FREQ_MONTHLY and #FREQ_YEARLY. @n
- * If the day of the month is 31 and the frequency is monthly, the months which have only 30 days are not included in the recurrence instance set. @c
- * Accordingly, with the recurrence rule, 2/29 yearly, 2/29 every four years will be included in the recurrence set.
+ * If the day of the month is @c 31 and the frequency is monthly, the months which have only @c 30 days are not included in the recurrence instance set. @c
+ * Accordingly, with the recurrence rule, 2/29 yearly, 2/29 every four years is included in the recurrence set.
*
* @since 2.0
*
* @return An error code
- * @param[in] day An integer value between @c 1 and @c 31 indicating the day of the month
+ * @param[in] day The integer value between @c 1 and @c 31 that indicates the day of the month
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c day is less than @c 1 or greater than @c 31.
+ * @exception E_INVALID_ARG The specified @c day is either less than @c 1 or greater than @c 31.
* @exception E_TYPE_MISMATCH The #RecurFrequency is not #FREQ_MONTHLY or #FREQ_YEARLY.
* @remarks After this property is set, the DayOfWeek and WeekOfMonth property value are reset automatically.
*/
* @since 2.0
*
* @return An error code
- * @param[in] week An integer value between @c 1 and @c 5 representing the week of the month
+ * @param[in] week The integer value between @c 1 and @c 5 that represents the week of the month
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c week is less than @c 1 or greater than @c 5.
+ * @exception E_INVALID_ARG The specified @c week is either less than @c 1 or greater than @c 5.
* @exception E_TYPE_MISMATCH The #RecurFrequency is not #FREQ_MONTHLY or #FREQ_YEARLY.
* @remarks After this property is set, the DayOfMonth property value is reset automatically.
*/
* @since 2.0
*
* @return An error code
- * @param[in] month An integer value between @c 1 and @c 12 representing the month of the year
+ * @param[in] month The integer value between @c 1 and @c 12 that represents the month of the year
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c month is less than @c 1 or greater than @c 12.
+ * @exception E_INVALID_ARG The specified @c month is either less than @c 1 or greater than @c 12.
* @exception E_TYPE_MISMATCH The #RecurFrequency is not #FREQ_YEARLY.
*/
result SetMonthOfYear(int month);
/**
* Adds an exception date to this event. @n
- * The instance that its start date and time matched with the exception date will be exclude from recurrence instances.
- * If there are any changes in this recurrence, the exception dates would be cleared.
+ * The instance whose start date and time matches the exception date is excluded from the recurrence instances.
+ * If there are any changes in this recurrence, the exception dates are cleared.
*
* @since 2.0
*
*
* @since 2.0
*
- * @return A list containing the exception dates, @n
+ * @return The list that contains the exception dates, @n
* else an empty list if there are no exception dates, or @c null if an exception occurs @n
* The results are listed in the order of date and time.
* @exception E_SUCCESS The method is successful.
*
* @since 2.0
*
- * @param[in] rhs An instance of %Recurrence
+ * @param[in] rhs An instance of %Recurrence to copy
*/
Recurrence& operator =(const Recurrence& rhs);
projects / framework / osp / social.git / blobdiff