Resolved Native API Reference issues for sppc 51/216751/1 accepted/tizen/unified/20191106.124728 submit/tizen/20191105.095057
authorAbhimanyu Swami <abhimanyu1.s@samsung.com>
Thu, 31 Oct 2019 12:44:10 +0000 (18:14 +0530)
committerAbhimanyu Swami <abhimanyu1.s@samsung.com>
Thu, 31 Oct 2019 12:44:10 +0000 (18:14 +0530)
Change-Id: I777a122deeb0a6833679775d40dbc258d8b11359
Signed-off-by: Abhimanyu Swami <abhimanyu1.s@samsung.com>
include/push-service.h

index 2a27586..abf91cd 100644 (file)
@@ -111,7 +111,7 @@ typedef void (*push_service_state_cb)(
 /**
  * @brief Called to handle a notification.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] notification A handle of the notification containing its payload\n
+ * @param[in] noti A handle of the notification containing its payload\n
  *                         The handle is available inside this callback only.
  * @param[in] user_data The user data passed to this callback
  * @see push_service_connect()
@@ -165,7 +165,7 @@ int push_service_connect(const char *push_app_id,
                push_service_connection_h *connection);
 
 /**
- * @brief Closes the connection and releases all its resources
+ * @brief. Closes the connection and releases all its resources
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @remarks If you call this function in the push callback functions,\n
  *          it may cause your application to crash.\n
@@ -231,7 +231,7 @@ int push_service_deregister(push_service_connection_h connection, push_service_r
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/push
- * @remark This function must be called in the app control callback function.\n
+ * @remarks This function must be called in the app control callback function.\n
  *                You must release the payload data using free().\n
  *                push_service_app_control_to_notification() is preferred to this API.\n
  *                The specific error code can be obtained using the get_last_result()\n
@@ -264,7 +264,7 @@ char *push_service_app_control_to_noti_data(app_control_h app_control, char *ope
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/push
- * @remark This function must be called in the app control callback function.\n
+ * @remarks This function must be called in the app control callback function.\n
  *                You must release the notification using push_service_free_notification().
  * @param[in] app_control The app control handle that is handed over in the\n
  *                        app control callback function
@@ -292,7 +292,7 @@ int push_service_app_control_to_notification(app_control_h app_control, char *op
  * @remarks You must release @a data using free().
  * @param[in] notification The notification handle
  * @param[out] data The notification data\n
- *                  Set NULL if error but <I>PUSH_SERVICE_ERROR_INVALID_PARAMETER</I>
+ *                  Set NULL if error but <I>#PUSH_SERVICE_ERROR_INVALID_PARAMETER</I>
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #PUSH_SERVICE_ERROR_NONE Successful
@@ -308,12 +308,12 @@ int push_service_get_notification_data(push_service_notification_h notification,
 /**
  * @brief Gets the notification message sent by the server.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remark The <I>msg</I> must be released with free().\n
+ * @remarks The <I>msg</I> must be released with free().\n
  *                push_service_request_unread_notification() is\n
  *                preferred to this API.
  * @param[in] notification The notification handle
  * @param[out] msg The notification message\n
- *                  Set NULL if error but <I>PUSH_SERVICE_ERROR_INVALID_PARAMETER</I>
+ *                  Set NULL if error but <I>#PUSH_SERVICE_ERROR_INVALID_PARAMETER</I>
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #PUSH_SERVICE_ERROR_NONE Successful
@@ -406,7 +406,7 @@ int push_service_get_notification_request_id(push_service_notification_h notific
                char **request_id);
 
 /**
- * @brief Gets the value in the type field of the notification
+ * @brief. Gets the value in the type field of the notification
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @param[in] notification The notification handle
  * @param[out] type The type value assigned by the sender
@@ -424,7 +424,7 @@ int push_service_get_notification_type(push_service_notification_h notification,
 /**
  * @brief Gets an unread notification message from the push server.
  * @details If an application receives an unread message with this method, the message is removed from the system. \n
- *          This method can be called repeatedly until it returns <I>PUSH_SERVICE_ERROR_NO_DATA</I> \n
+ *          This method can be called repeatedly until it returns <I>#PUSH_SERVICE_ERROR_NO_DATA</I> \n
  *          But, this method does NOT guarantee order and reliability of notification messages. \n
  *          Some notification messages can be dropped when the system message queue is full.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -472,12 +472,12 @@ int push_service_get_unread_notification(push_service_connection_h connection,
 int push_service_request_unread_notification(push_service_connection_h connection);
 
 /**
- * @brief Gets the registration ID in the <I>PUSH_SERVICE_STATE_REGISTERED</I> state.
+ * @brief Gets the registration ID in the <I>#PUSH_SERVICE_STATE_REGISTERED</I> state.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @remarks You must release @a reg_id using free().
  * @param[in] connection The connection handle to the push service
  * @param[out] reg_id The registration ID\n
- *                    Set NULL if error but <I>PUSH_SERVICE_ERROR_INVALID_PARAMETER</I>
+ *                    Set NULL if error but <I>#PUSH_SERVICE_ERROR_INVALID_PARAMETER</I>
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #PUSH_SERVICE_ERROR_NONE Successful
@@ -491,7 +491,7 @@ int push_service_get_registration_id(push_service_connection_h connection, char
 /**
  * @brief Frees the notification handle.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remark The specific error code can be obtained using the get_last_result()\n
+ * @remarks The specific error code can be obtained using the get_last_result()\n
  *                Error codes are described in the exception section.
  * @param[in] noti The notification handle
  * @exception #PUSH_SERVICE_ERROR_NONE Successful