summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNishant Chaprana <n.chaprana@samsung.com>2019-08-21 18:32:22 +0530
committersaerome.kim <saerome.kim@samsung.com>2019-08-22 09:48:38 +0900
commit128622169bb49e6f7f967ff1555379517405e033 (patch)
tree3d9c032df00f5b1d13e5caf9d682ed07ad9ac60d
parent658cc61755d6d4012b44e19f6b64ca8c207660aa (diff)
downloaduser-awareness-128622169bb49e6f7f967ff1555379517405e033.tar.gz
user-awareness-128622169bb49e6f7f967ff1555379517405e033.tar.bz2
user-awareness-128622169bb49e6f7f967ff1555379517405e033.zip
Change-Id: I451507a3399669cabfa73ef8db109c7fbdeee7a2 Signed-off-by: Nishant Chaprana <n.chaprana@samsung.com>
-rwxr-xr-x[-rw-r--r--]include/user-awareness.h30
1 files changed, 17 insertions, 13 deletions
diff --git a/include/user-awareness.h b/include/user-awareness.h
index b09b657..7351e13 100644..100755
--- a/include/user-awareness.h
+++ b/include/user-awareness.h
@@ -98,7 +98,7 @@ extern "C" {
/**
* @ingroup CAPI_NETWORK_UA_MODULE
- * @brief Device's BT mac address(payload) length
+ * @brief Device's BT mac address(payload) length.
* @since_tizen 5.5
*/
#define UA_BT_MAC_MAX_LEN 18
@@ -1432,6 +1432,7 @@ int ua_user_add_device(
ua_device_h device_handle,
ua_user_device_added_cb callback,
void *user_data);
+
/**
* @ingroup CAPI_NETWORK_UA_MODULE
* @brief Removes the device handle for a user handle.
@@ -1570,7 +1571,8 @@ int ua_service_remove(
* @brief Gets default service handle.
* @since_tizen 5.5
*
- * @remarks The @a service_handle should not be released.
+ * @remarks The @a service_handle is managed by the platform and will be released
+ * when #ua_deinitialize() is called.
*
* @param[out] service_handle The service handle
*
@@ -1594,6 +1596,8 @@ int ua_service_get_default_service(
* @brief Gets service handle by service name.
* @since_tizen 5.5
*
+ * @remarks The @a service_handle should be destroyed by using #ua_service_destroy().
+ *
* @param[in] name The service name information
* @param[out] service_handle The service handle
*
@@ -2276,7 +2280,7 @@ int ua_device_update(
* @brief Sets BLE payload service_id for device.
* @since_tizen 5.5
*
- * @param[in] device_handle The device handle
+ * @param[in] handle The device handle.
* @param[in] service_id The BLE payload service_id.
*
* @return 0 on success, otherwise a negative error value
@@ -2298,7 +2302,7 @@ int ua_device_set_payload_service_id(
* @brief Sets BLE payload device_icon for device.
* @since_tizen 5.5
*
- * @param[in] device_handle The device handle
+ * @param[in] handle The device handle.
* @param[in] device_icon The BLE payload device_icon.
*
* @return 0 on success, otherwise a negative error value
@@ -2320,7 +2324,7 @@ int ua_device_set_payload_device_icon(
* @brief Sets BLE payload purpose for device.
* @since_tizen 5.5
*
- * @param[in] device_handle The device handle
+ * @param[in] handle The device handle.
* @param[in] purpose The BLE payload purpose.
*
* @return 0 on success, otherwise a negative error value
@@ -2342,11 +2346,11 @@ int ua_device_set_payload_purpose(
* @brief Sets BLE payload DUID for device.
* @since_tizen 5.5
*
- * @remarks duid is expected to be exact 17 bytes long data
- * and may have intermediate NULLs
+ * @remarks The @a duid is expected to be exact 17 bytes long data
+ * and may have intermediate NULLs
*
- * @param[in] device_handle The device handle
- * @param[in] duid_len The BLE payload DUID's length
+ * @param[in] handle The device handle.
+ * @param[in] duid_len The BLE payload DUID's length.
* @param[in] duid The BLE payload DUID.
*
* @return 0 on success, otherwise a negative error value
@@ -2369,7 +2373,7 @@ int ua_device_set_payload_duid(
* @brief Gets device's BLE payload service_id.
* @since_tizen 5.5
*
- * @param[in] device_handle The device handle
+ * @param[in] handle The device handle.
* @param[out] service_id The BLE payload service_id.
*
* @return 0 on success, otherwise a negative error value
@@ -2391,7 +2395,7 @@ int ua_device_get_payload_service_id(
* @brief Gets device's BLE payload device_icon.
* @since_tizen 5.5
*
- * @param[in] device_handle The device handle
+ * @param[in] handle The device handle.
* @param[out] device_icon The BLE payload device_icon.
*
* @return 0 on success, otherwise a negative error value
@@ -2413,7 +2417,7 @@ int ua_device_get_payload_device_icon(
* @brief Gets device's BLE payload purpose.
* @since_tizen 5.5
*
- * @param[in] device_handle The device handle
+ * @param[in] handle The device handle.
* @param[out] purpose The BLE payload purpose.
*
* @return 0 on success, otherwise a negative error value
@@ -2437,7 +2441,7 @@ int ua_device_get_payload_purpose(
*
* @remarks You must release @a duid using g_free().
*
- * @param[in] device_handle The device handle
+ * @param[in] handle The device handle.
* @param[out] duid The BLE payload DUID.
*
* @return 0 on success, otherwise a negative error value