Resolved Native API Reference issues for calendar-service

Change-Id: I44b19c45f6c3fa9ea330607199f7d5ca1be244cf
Signed-off-by: Abhimanyu Swami <abhimanyu1.s@samsung.com>

diff --git a/doc/calendar_doc.h b/doc/calendar_doc.h
index a5b24f5..691c2b6 100644 (file)
--- a/doc/calendar_doc.h
+++ b/doc/calendar_doc.h
@@ -216,28 +216,28 @@
  * </tr>
  * <tr>
  *     <td> integer </td>
- *     <td> calendar_record_set_int </td>
- *     <td> calendar_record_get_int </td>
+ *     <td> calendar_record_set_int() </td>
+ *     <td> calendar_record_get_int() </td>
  * </tr>
  * <tr>
  *     <td> long long integer </td>
- *     <td> calendar_record_set_lli </td>
- *     <td> calendar_record_get_lli </td>
+ *     <td> calendar_record_set_lli() </td>
+ *     <td> calendar_record_get_lli() </td>
  * </tr>
  * <tr>
  *     <td> double </td>
- *     <td> calendar_record_set_double </td>
- *     <td> calendar_record_get_double </td>
+ *     <td> calendar_record_set_double() </td>
+ *     <td> calendar_record_get_double() </td>
  * </tr>
  * <tr>
  *     <td> string </td>
- *     <td> calendar_record_set_str </td>
- *     <td> calendar_record_get_str </td>
+ *     <td> calendar_record_set_str() </td>
+ *     <td> calendar_record_get_str() </td>
  * </tr>
  * <tr>
  *     <td> calendar_time_s </td>
- *     <td> calendar_record_set_caltime </td>
- *     <td> calendar_record_get_caltime </td>
+ *     <td> calendar_record_set_caltime() </td>
+ *     <td> calendar_record_get_caltime() </td>
  * </tr>
  * </table>
  * A record's type is identified by a structure called the view. For example,
@@ -290,15 +290,15 @@
  * <table>
  * <caption> Table: Calendar books </caption>
  * <tr>
- *  <td> DEFAULT_EVENT_CALENDAR_BOOK_ID </td>
+ *  <td> #DEFAULT_EVENT_CALENDAR_BOOK_ID </td>
  *  <td> Event book </td>
  * </tr>
  * <tr>
- *  <td> DEFAULT_TODO_CALENDAR_BOOK_ID </td>
+ *  <td> #DEFAULT_TODO_CALENDAR_BOOK_ID </td>
  *  <td> Todo book </td>
  * </tr>
  * <tr>
- *  <td> DEFAULT_BIRTHDAY_CALENDAR_BOOK_ID </td>
+ *  <td> #DEFAULT_BIRTHDAY_CALENDAR_BOOK_ID </td>
  *  <td> Birthday book </td>
  * </tr>
  * </table>
@@ -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.
  * <table>
  * <caption> Table: Data types </caption>
@@ -475,13 +475,13 @@
  *     <th> Purpose </th>
  * </tr>
  * <tr>
- *     <td> CALENDAR_TIME_UTIME </td>
+ *     <td> #CALENDAR_TIME_UTIME </td>
  *     <td> long long int </td>
  *     <td> utime </td>
  *     <td> UTC time, used to describe non-all-day events </td>
  * </tr>
  * <tr>
- *     <td> CALENDAR_TIME_LOCALTIME </td>
+ *     <td> #CALENDAR_TIME_LOCALTIME </td>
  *     <td> struct </td>
  *     <td> date </td>
  *     <td> date only (year, month and day of the month), used to describe all day events </td>
@@ -611,7 +611,7 @@
  *  <th> Comment </th>
  * </tr>
  * <tr>
- *  <td> CALENDAR_RECURRENCE_YEARLY </td>
+ *  <td> #CALENDAR_RECURRENCE_YEARLY </td>
  *  <td> byyearday </td>
  *  <td> Every 100th day </td>
  * </tr>
@@ -631,7 +631,7 @@
  *  <td> Every 1st Monday of May (holiday) </td>
  * </tr>
  * <tr>
- *  <td> CALENDAR_RECURRENCE_MONTHLY </td>
+ *  <td> #CALENDAR_RECURRENCE_MONTHLY </td>
  *  <td> bymonthday </td>
  *  <td> Every 29th (payday) </td>
  * </tr>
@@ -641,12 +641,12 @@
  *  <td> Every last Friday </td>
  * </tr>
  * <tr>
- *  <td> CALENDAR_RECURRENCE_WEEKLY </td>
+ *  <td> #CALENDAR_RECURRENCE_WEEKLY </td>
  *  <td> byday </td>
  *  <td> Every week </td>
  * </tr>
  * <tr>
- *  <td> CALENDAR_RECURRENCE_DAILY </td>
+ *  <td> #CALENDAR_RECURRENCE_DAILY </td>
  *  <td> - </td>
  *  <td> - </td>
  * </tr>
@@ -660,15 +660,15 @@
  *  <th> Comment </th>
  * </tr>
  * <tr>
- *  <td> CALENDAR_RANGE_NONE </td>
+ *  <td> #CALENDAR_RANGE_NONE </td>
  *  <td> Endless(max date is 2036/12/31) </td>
  * </tr>
  * <tr>
- *  <td> CALENDAR_RANGE_UNTIL </td>
+ *  <td> #CALENDAR_RANGE_UNTIL </td>
  *  <td> Should set until property </td>
  * </tr>
  * <tr>
- *  <td> CALENDAR_RANGE_COUNT </td>
+ *  <td> #CALENDAR_RANGE_COUNT </td>
  *  <td> Should set count property </td>
  * </tr>
  * </table>
@@ -845,27 +845,27 @@
  *     <th> comment </th>
  * </tr>
  * <tr>
- *     <td> CALENDAR_ALARM_TIME_UNIT_SPECIFIC </td>
+ *     <td> #CALENDAR_ALARM_TIME_UNIT_SPECIFIC </td>
  *     <td> time </td>
  *     <td> This represents the number of seconds elapsed since the Epoch, 1970-01-01 00:00:00 +0000 (UTC) </td>
  * </tr>
  * <tr>
- *     <td> CALENDAR_ALARM_TIME_UNIT_WEEK </td>
+ *     <td> #CALENDAR_ALARM_TIME_UNIT_WEEK </td>
  *     <td> tick </td>
  *     <td> The number of weeks before start time </td>
  * </tr>
  * <tr>
- *     <td> CALENDAR_ALARM_TIME_UNIT_DAY </td>
+ *     <td> #CALENDAR_ALARM_TIME_UNIT_DAY </td>
  *     <td> tick </td>
  *     <td> The number of days before start time </td>
  * </tr>
  * <tr>
- *     <td> CALENDAR_ALARM_TIME_UNIT_HOUR </td>
+ *     <td> #CALENDAR_ALARM_TIME_UNIT_HOUR </td>
  *     <td> tick </td>
  *     <td> The number of hours before start time </td>
  * </tr>
  * <tr>
- *     <td> CALENDAR_ALARM_TIME_UNIT_MINUTE </td>
+ *     <td> #CALENDAR_ALARM_TIME_UNIT_MINUTE </td>
  *     <td> tick </td>
  *     <td> The number of minutes before start time </td>
  * </tr>
@@ -1092,28 +1092,28 @@
  * </tr>
  * <tr>
  *     <td> integer </td>
- *     <td> calendar_record_set_int </td>
- *     <td> calendar_record_get_int </td>
+ *     <td> calendar_record_set_int() </td>
+ *     <td> calendar_record_get_int() </td>
  * </tr>
  * <tr>
  *     <td> long long integer </td>
- *     <td> calendar_record_set_lli </td>
- *     <td> calendar_record_get_lli </td>
+ *     <td> calendar_record_set_lli() </td>
+ *     <td> calendar_record_get_lli() </td>
  * </tr>
  * <tr>
  *     <td> double </td>
- *     <td> calendar_record_set_double </td>
- *     <td> calendar_record_get_double </td>
+ *     <td> calendar_record_set_double() </td>
+ *     <td> calendar_record_get_double() </td>
  * </tr>
  * <tr>
  *     <td> string </td>
- *     <td> calendar_record_set_str </td>
- *     <td> calendar_record_get_str </td>
+ *     <td> calendar_record_set_str() </td>
+ *     <td> calendar_record_get_str() </td>
  * </tr>
  * <tr>
  *     <td> calendar_time_s </td>
- *     <td> calendar_record_set_caltime </td>
- *     <td> calendar_record_get_caltime </td>
+ *     <td> calendar_record_set_caltime() </td>
+ *     <td> calendar_record_get_caltime() </td>
  * </tr>
  * </table>
  * 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 (file)
--- 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 (file)
--- 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 (file)
--- 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
  */