//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
* @since 2.0
*
* @return @c true if the input object equals the calling %CalEvent instance, @n
- else @c false
+ * else @c false
* @param[in] rhs The object instance to compare with the calling object
* @see GetHashCode()
*/
* UID: globally Unique Identifier (vCalendar 1.0)
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because string value can’t be handled. @n
+ * @deprecated This method is deprecated because string value cannot be handled. @n
* Instead of using this method, it is recommended to use GetUid().
* @since 2.0
*
* UID: globally Unique Identifier (vCalendar 1.0)
*
* @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because string value can’t be handled. @n
+ * @deprecated This method is deprecated because string value cannot be handled. @n
* Instead of using this method, it is recommended to use SetUid().
* @since 2.0
*
*
* @brief <i> [Compatibility] </i>
* @since 2.0
- * @compatibility This method has compatibility issues with Tizen API versions @b prior @b to @b 2.1. @n
+ * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.1. @n
* For more information, see @ref CompCalEventAddAttendeePage "here".
*
* @return An error code
/**
* @page CompCalEventAddAttendeePage Compatibility for AddAttendee()
* @section CompCalEventAddAttendeePageIssueSection Issues
- * Implementation of this method in Tizen API versions prior to 2.1 has the following issue: @n
- * -# If the email of @c attendee is empty, the E_OBJ_ALREADY_EXIST is returned.
+ * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n
+ * - If the email of @c attendee is empty, the @c E_OBJ_ALREADY_EXIST is returned.
*
* @section CompCalEventAddAttendeePageSolutionSection Resolutions
- * The issue mentioned above is resolved in Tizen API version 2.1.
- * -# The E_INVALID_ARG will be returned, if the email of @c attendee is empty.
+ * The issue mentioned above is resolved in %Tizen API version 2.1.
+ * - If the email of @c attendee is empty, the @c E_INVALID_ARG is returned.
*/
/**
/**
* @if OSPDEPREC
* Gets the recurrence ID. @n
- * This method works only for the %CalEvent instances.
+ * The %GetRecurrenceId() method works only for the %CalEvent instances.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated because %CalEvent class is not used for event instance any more. @n
* @if OSPCOMPAT
* @page CompCalEventSetSubjectPage Compatibility for SetSubject()
* @section CompCalEventSetSubjectPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the subject to be set is greater than 100 characters, E_INVALID_ARG is returned.
*
* @section CompCalEventSetSubjectPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the subject.
* @endif
*/
* @if OSPCOMPAT
* @page CompCalEventSetDescriptionPage Compatibility for SetDescription()
* @section CompCalEventSetDescriptionPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the description to be set is greater than 1000 characters, E_INVALID_ARG is returned.
*
* @section CompCalEventSetDescriptionPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the description.
* @endif
*/
* @since 2.0
*
* @return An error code
- * @param[in] startDateTime The start date and time
- * @param[in] endDateTime The end date and time
+ * @param[in] startDateTime The start date and time. @n Any value with a unit that is less than a second is ignored.
+ * @param[in] endDateTime The end date and time. @n Any value with a unit that is less than a second is ignored.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified @c endDateTime value is earlier than the specified @c startDateTime value.
- * - The @c startDateTime or @c endDateTime is not in a valid range. @n
+ * - The @c startDateTime or @c endDateTime is out of the valid range. @n
* The valid range of the date can be referenced from GetMaxDateTime() and GetMinDateTime().
* @exception E_INVALID_CONDITION The recurrence date is already set.
* @remarks The start and end time of all day events created from the base applications is the local time of the location where
* @if OSPCOMPAT
* @page CompCalEventSetLocationPage Compatibility for SetLocation()
* @section CompCalEventSetLocationPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* -# If the length of the location to be set is greater than 100 characters, E_INVALID_ARG is returned.
*
* @section CompCalEventSetLocationPageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# There is no limit for the length of the location.
* @endif
*/
/**
- * @if OSPDEPREC
- * @{
- * Sets the category of the calendar event. @n
+ * @cond OSPDEPREC
+ * Sets the category of the calendar event. @n
* If the category is not set, the default category (#EVENT_CATEGORY_APPOINTMENT) is set.
*
* @if OSPCOMPAT
* they are added.
* All the other events are Coordinated Universal Time (UTC).
* In order to integrate it with the base applications, set the start and end time properly according to the above guidelines.
- * @}
- * @endif
+ * @endcond
*/
void SetCategory(EventCategory category);
* @if OSPCOMPAT
* @page CompCalEventSetCategoryPage Compatibility for SetCategory()
* @section CompCalEventSetCategoryPageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
*
- * -# When the anniversary category is set to the event, it's handled as all day event even though the all day event property is not set.
+ * -# When the anniversary category is set to the event, it is handled as all day event even though the all day event property is not set.
*
* @section CompCalEventSetCategoryPageSolutionSection Resolutions
*
- * This issue has been resolved in Tizen. @n
- * -# The category property is deprecated and it's not used any more.
+ * This issue has been resolved in Tizen. @n
+ * -# The category property is deprecated and it is not used any more.
* In Tizen, the all day event property will be set simultaneously when the anniversary category is set to the event.
* If an application tries to change the all day event property of the anniversary event to @c false, it will not be changed.
* @endif
* - When the frequency is #FREQ_MONTHLY, neither DayOfMonth nor DayOfWeek and WeekOfMonth are not set. @n
* - When the frequency is #FREQ_YEARLY, neither DayOfMonth and MonthOfYear nor DayOfWeek,
* WeekOfMonth and MonthOfYear are not set. @n
- * - When the frequency is #FREQ_YEARLY and MonthOfYear is 2, DayOfMonth is greater than 29 ( > 29 ). @n
+ * - When the frequency is #FREQ_YEARLY and MonthOfYear is 2, DayOfMonth is greater than 29 (> 29). @n
* - When the frequency is #FREQ_YEARLY and MonthOfYear is 4 or 6 or 9 or 11,
- * DayOfMonth is greater than 30 ( > 30 ).
- * @exception E_SYSTEM A system error has occurred.
+ * DayOfMonth is greater than 30 (> 30).
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks If the until property of the recurrence is set with too distant future from the event's start date, @n
* too many recurring events are generated. It is the same when the value of recurrence count is big. @n
* The system limits the count of the recurring events that are generated by recurrence rule of an event. @n
* @if OSPCOMPAT
* @page CompCalEventSetRecurrencePage Compatibility for SetRecurrence()
* @section CompCalEventSetRecurrencePageIssueSection Issues
- * Implementing this method in OSP compatible applications has the following issues: @n
+ * Implementing this method in OSP compatible applications has the following issues: @n
* - If the category is anniversary and the frequency of recurrence is not yearly, E_TYPE_MISMATCH exception is occurred. @n
* Yearly frequency is only accepted for anniversary category.
*
* @section CompCalEventSetRecurrencePageSolutionSection Resolutions
- * This issue has been resolved in Tizen. @n
+ * This issue has been resolved in Tizen. @n
* -# All recurrence frequency will be accepted because the category of event is not used any more.
* @endif
*/
/**
* Gets the base event ID.
- * This method return the id of the base recurring event for which this event is a recurrence exception.
+ * This method return the ID of the base recurring event for which this event is a recurrence exception.
*
* @since 2.1
*
projects / framework / osp / social.git / blobdiff