From d43b0b3620b57a3644f7877044d569166e8db562 Mon Sep 17 00:00:00 2001 From: Abhimanyu Swami Date: Thu, 31 Oct 2019 15:34:25 +0530 Subject: [PATCH] Resolved Native API Reference issues for calendar-service Change-Id: I44b19c45f6c3fa9ea330607199f7d5ca1be244cf Signed-off-by: Abhimanyu Swami --- doc/calendar_doc.h | 78 +++++++++++++++++++++++------------------------ include/calendar_db.h | 8 ++--- include/calendar_record.h | 2 +- include/calendar_types.h | 34 +++++++++++++++++++++ 4 files changed, 77 insertions(+), 45 deletions(-) diff --git a/doc/calendar_doc.h b/doc/calendar_doc.h index a5b24f5..691c2b6 100644 --- a/doc/calendar_doc.h +++ b/doc/calendar_doc.h @@ -216,28 +216,28 @@ * * * integer - * calendar_record_set_int - * calendar_record_get_int + * calendar_record_set_int() + * calendar_record_get_int() * * * long long integer - * calendar_record_set_lli - * calendar_record_get_lli + * calendar_record_set_lli() + * calendar_record_get_lli() * * * double - * calendar_record_set_double - * calendar_record_get_double + * calendar_record_set_double() + * calendar_record_get_double() * * * string - * calendar_record_set_str - * calendar_record_get_str + * calendar_record_set_str() + * calendar_record_get_str() * * * calendar_time_s - * calendar_record_set_caltime - * calendar_record_get_caltime + * calendar_record_set_caltime() + * calendar_record_get_caltime() * * * A record's type is identified by a structure called the view. For example, @@ -290,15 +290,15 @@ * * * - * + * * * * - * + * * * * - * + * * * *
Table: Calendar books
DEFAULT_EVENT_CALENDAR_BOOK_ID #DEFAULT_EVENT_CALENDAR_BOOK_ID Event book
DEFAULT_TODO_CALENDAR_BOOK_ID #DEFAULT_TODO_CALENDAR_BOOK_ID Todo book
DEFAULT_BIRTHDAY_CALENDAR_BOOK_ID #DEFAULT_BIRTHDAY_CALENDAR_BOOK_ID Birthday book
@@ -463,8 +463,8 @@ * (_CALENDAR_PROPERTY_CALTIME) properties of records. * It can hold two types of data: UTC time (long long int) and date, * given as year, month and day of the month (three integers). These types - * are identified by values of calendar_time_type_e, which are CALENDAR_TIME_UTIME - * and CALENDAR_TIME_LOCALTIME, respectively. The data type determines the usage + * are identified by values of calendar_time_type_e, which are #CALENDAR_TIME_UTIME + * and #CALENDAR_TIME_LOCALTIME, respectively. The data type determines the usage * of the structure. * * @@ -475,13 +475,13 @@ * * * - * + * * * * * * - * + * * * * @@ -611,7 +611,7 @@ * * * - * + * * * * @@ -631,7 +631,7 @@ * * * - * + * * * * @@ -641,12 +641,12 @@ * * * - * + * * * * * - * + * * * * @@ -660,15 +660,15 @@ * * * - * + * * * * - * + * * * * - * + * * * *
Table: Data types
Purpose
CALENDAR_TIME_UTIME #CALENDAR_TIME_UTIME long long int utime UTC time, used to describe non-all-day events
CALENDAR_TIME_LOCALTIME #CALENDAR_TIME_LOCALTIME struct date date only (year, month and day of the month), used to describe all day events Comment
CALENDAR_RECURRENCE_YEARLY #CALENDAR_RECURRENCE_YEARLY byyearday Every 100th day
Every 1st Monday of May (holiday)
CALENDAR_RECURRENCE_MONTHLY #CALENDAR_RECURRENCE_MONTHLY bymonthday Every 29th (payday)
Every last Friday
CALENDAR_RECURRENCE_WEEKLY #CALENDAR_RECURRENCE_WEEKLY byday Every week
CALENDAR_RECURRENCE_DAILY #CALENDAR_RECURRENCE_DAILY - -
Comment
CALENDAR_RANGE_NONE #CALENDAR_RANGE_NONE Endless(max date is 2036/12/31)
CALENDAR_RANGE_UNTIL #CALENDAR_RANGE_UNTIL Should set until property
CALENDAR_RANGE_COUNT #CALENDAR_RANGE_COUNT Should set count property
@@ -845,27 +845,27 @@ * comment * * - * CALENDAR_ALARM_TIME_UNIT_SPECIFIC + * #CALENDAR_ALARM_TIME_UNIT_SPECIFIC * time * This represents the number of seconds elapsed since the Epoch, 1970-01-01 00:00:00 +0000 (UTC) * * - * CALENDAR_ALARM_TIME_UNIT_WEEK + * #CALENDAR_ALARM_TIME_UNIT_WEEK * tick * The number of weeks before start time * * - * CALENDAR_ALARM_TIME_UNIT_DAY + * #CALENDAR_ALARM_TIME_UNIT_DAY * tick * The number of days before start time * * - * CALENDAR_ALARM_TIME_UNIT_HOUR + * #CALENDAR_ALARM_TIME_UNIT_HOUR * tick * The number of hours before start time * * - * CALENDAR_ALARM_TIME_UNIT_MINUTE + * #CALENDAR_ALARM_TIME_UNIT_MINUTE * tick * The number of minutes before start time * @@ -1092,28 +1092,28 @@ * * * integer - * calendar_record_set_int - * calendar_record_get_int + * calendar_record_set_int() + * calendar_record_get_int() * * * long long integer - * calendar_record_set_lli - * calendar_record_get_lli + * calendar_record_set_lli() + * calendar_record_get_lli() * * * double - * calendar_record_set_double - * calendar_record_get_double + * calendar_record_set_double() + * calendar_record_get_double() * * * string - * calendar_record_set_str - * calendar_record_get_str + * calendar_record_set_str() + * calendar_record_get_str() * * * calendar_time_s - * calendar_record_set_caltime - * calendar_record_get_caltime + * calendar_record_set_caltime() + * calendar_record_get_caltime() * * * For long long integer functions, "lli" stands for long long int, usually used to hold UTC time. diff --git a/include/calendar_db.h b/include/calendar_db.h index a370059..2c31dad 100644 --- a/include/calendar_db.h +++ b/include/calendar_db.h @@ -237,7 +237,7 @@ int calendar_db_get_records_with_query(calendar_query_h query, int offset, int l * @retval #CALENDAR_ERROR_OUT_OF_MEMORY Out of memory * @retval #CALENDAR_ERROR_SYSTEM Internal system module error * @retval #CALENDAR_ERROR_NOT_SUPPORTED Not supported - * @pre This function requires an open connection to the calendar service using calendar_connect2(). + * @pre This function requires an open connection to the calendar service using calendar_connect(). * @see calendar_connect() */ int calendar_db_get_count(const char* view_uri, int *count); @@ -262,8 +262,8 @@ int calendar_db_get_count(const char* view_uri, int *count); * @retval #CALENDAR_ERROR_OUT_OF_MEMORY Out of memory * @retval #CALENDAR_ERROR_SYSTEM Internal system module error * @retval #CALENDAR_ERROR_NOT_SUPPORTED Not supported - * @pre This function requires an open connection to the calendar service using calendar_connect2(). - * @see calendar_connect2() + * @pre This function requires an open connection to the calendar service using calendar_connect(). + * @see calendar_connect() */ int calendar_db_get_count_with_query(calendar_query_h query, int *count); @@ -348,7 +348,6 @@ int calendar_db_update_records(calendar_list_h record_list); * @pre calendar_connect() should be called to open a connection to the calendar service. * @see calendar_connect() * @see calendar_db_insert_records() - * @see calendar_db_delete_records() */ int calendar_db_delete_records(const char* view_uri, int record_id_array[], int count); @@ -511,7 +510,6 @@ int calendar_db_insert_vcalendars(const char* vcalendar_stream, int **record_id_ * @retval #CALENDAR_ERROR_NOT_SUPPORTED Not supported * @pre This function requires an open connection to the calendar service by calendar_connect(). * @see calendar_connect() - * @see calendar_db_replace_vcalendars() */ int calendar_db_replace_vcalendars(const char* vcalendar_stream, int *record_id_array, int count); diff --git a/include/calendar_record.h b/include/calendar_record.h index 60dcfa8..1b753ea 100644 --- a/include/calendar_record.h +++ b/include/calendar_record.h @@ -390,7 +390,7 @@ int calendar_record_get_child_record_at_p(calendar_record_h record, unsigned int /** * @brief Makes a clone of a given record's child record list. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif - * @remarks You must release @a cloned_list using calendar_list_destroy(). + * @remarks You must release @a out_list using calendar_list_destroy(). * @param[in] record The record handle * @param[in] property_id The property ID * @param[out] out_list The cloned list handle diff --git a/include/calendar_types.h b/include/calendar_types.h index 3cbb7ba..2f32031 100644 --- a/include/calendar_types.h +++ b/include/calendar_types.h @@ -55,13 +55,47 @@ extern "C" { #define _CALENDAR_END_READ_ONLY_VIEW(name) } name##_property_ids; \ extern __attribute__ ((visibility("default"))) const name##_property_ids name; +/** + * @addtogroup CAPI_SOCIAL_CALENDAR_SVC_DATABASE_MODULE + * @{ + */ + +/** + * @brief Handle for calendar record. + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif + */ _CALENDAR_HANDLE(calendar_record_h) + +/** + * @brief Handle for calendar filter. + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif + */ _CALENDAR_HANDLE(calendar_filter_h) + +/** + * @brief Handle for calendar list. + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif + */ _CALENDAR_HANDLE(calendar_list_h) + +/** + * @brief Handle for calendar query. + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif + */ _CALENDAR_HANDLE(calendar_query_h) + +/** + * @brief The calendar handle. + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 3.0 @elseif TV 4.0 @endif + */ _CALENDAR_HANDLE(calendar_h) /** + * @} + */ + + +/** * @file calendar_types.h */ -- 2.7.4