Rename callback for registered devices

This patch renames the callback:
- ua_registered_dev_cb ==> ua_registered_device_cb
Additionally, this patch update the API descriptions.

Change-Id: Id93ec6860edebf1faee2dc132db236df652e6fb5
Signed-off-by: Abhay Agarwal <ay.agarwal@samsung.com>

diff --git a/include/user-awareness-internal.h b/include/user-awareness-internal.h
index 2fbed604a14b0073c7020e9acc907b3d8aabd841..7b2fddf465484000aaa3c31e53ebcdaa8bbcaf96 100755 (executable)
--- a/include/user-awareness-internal.h
+++ b/include/user-awareness-internal.h
@@ -98,10 +98,10 @@ int ua_foreach_users(
  * @pre
  * @post
  *
- * @see ua_registered_dev_cb()
+ * @see ua_registered_device_cb()
  */
 int ua_foreach_devices(
-               ua_registered_dev_cb foreach_cb,
+               ua_registered_device_cb foreach_cb,
                void *user_data);
 
 /**
@@ -563,11 +563,11 @@ int ua_device_set_discriminant(ua_device_h device_handle,
  * @pre
  * @post
  *
- * @see ua_registered_dev_cb()
+ * @see ua_registered_device_cb()
  */
 int ua_device_foreach_added_by_user(
                ua_user_h user_handle,
-               ua_registered_dev_cb foreach_cb,
+               ua_registered_device_cb foreach_cb,
                void *user_data) TIZEN_DEPRECATED_API;
 
 /**
@@ -591,7 +591,7 @@ int ua_device_foreach_added_by_user(
  * @pre
  * @post
  *
- * @see ua_registered_dev_cb()
+ * @see ua_registered_device_cb()
  * @see ua_device_destroy()
  */
 int ua_device_clone(

diff --git a/include/user-awareness-private.h b/include/user-awareness-private.h
index 25d61311d82d5f77ef2c9261e0b7451086fbb501..6403f0a8510bb9ad6edd2ef2b63233c0bd3d7615 100755 (executable)
--- a/include/user-awareness-private.h
+++ b/include/user-awareness-private.h
@@ -944,7 +944,7 @@ void _ua_handle_device_removed(int result, uam_device_info_s *uam_info);
  */
 int _ua_foreach_devices_by_user(
                ua_user_h user_handle,
-               ua_registered_dev_cb foreach_cb,
+               ua_registered_device_cb foreach_cb,
                void *user_data);
 
 /**

diff --git a/include/user-awareness-type.h b/include/user-awareness-type.h
index 2bc8da6a85f2df6f235663a7742b292eaa5b538f..3face28bdcd95b91f1f7add4c8a7ce3d37c8936e 100755 (executable)
--- a/include/user-awareness-type.h
+++ b/include/user-awareness-type.h
@@ -199,7 +199,7 @@ typedef enum {
 
 /**
  * @ingroup CAPI_NETWORK_UA_MODULE
- * @brief Enumeration for sensor status.
+ * @brief Enumeration for sensor status report.
  * @since_tizen 6.5
  */
 typedef enum {
@@ -256,7 +256,7 @@ typedef void *ua_device_h;
  * @param[in] monitor The monitor handle for which sensor type was added.
  * @param[in] sensor The list of sensor handles on which user is not detected.
  * @param[in] sensor_type The type of sensor detected.
- * @param[in] status The status of sensor detected.
+ * @param[in] report The status report of sensor detected.
  * @param[in] user_data The user data passed in ua_monitor_set_sensor_status_cb().
  *
  */
@@ -264,7 +264,7 @@ typedef void (*ua_sensor_status_changed_cb)(
                ua_monitor_h monitor,
                ua_sensor_h sensor,
                ua_sensor_type_e sensor_type,
-               ua_sensor_report_e status,
+               ua_sensor_report_e report,
                void *user_data);
 
 /**
@@ -275,7 +275,7 @@ typedef void (*ua_sensor_status_changed_cb)(
  * @param[in] sensor_type Sensor type which is present in UA monitor.
  * @param[in] user_data User data passed in ua_monitor_foreach_sensor().
  *
- * @return True to continue with the next iteration of the loop
+ * @return @c true to continue with the next iteration of the loop, @c false to break out of the loop
  * and False to break out of the loop
  *
  * @see ua_monitor_foreach_sensor()
@@ -396,12 +396,11 @@ typedef void (*ua_absence_detected_cb)(
  * @param[in] device The device handle.
  * @param[in] user_data User data passed in ua_user_foreach_devices().
  *
- * @return True to continue with the next iteration of the loop
- * and False to break out of the loop
+ * @return @c true to continue with the next iteration of the loop, @c false to break out of the loop
  *
  * @see ua_user_foreach_devices()
  */
-typedef bool (*ua_registered_dev_cb)(
+typedef bool (*ua_registered_device_cb)(
                ua_device_h device,
                void *user_data);
 
@@ -416,8 +415,7 @@ typedef bool (*ua_registered_dev_cb)(
  * @param[in] service The service handle.
  * @param[in] user_data User data passed in ua_foreach_service().
  *
- * @return True to continue with the next iteration of the loop
- * and False to break out of the loop
+ * @return @c true to continue with the next iteration of the loop, @c false to break out of the loop
  *
  * @see ua_foreach_service()
  */
@@ -439,8 +437,7 @@ typedef bool (*ua_service_cb)(
  * @param[in] user The user handle.
  * @param[in] user_data User data passed in ua_service_foreach_users().
  *
- * @return True to continue with the next iteration of the loop
- * and False to break out of the loop
+ * @return @c true to continue with the next iteration of the loop, @c false to break out of the loop
  *
  * @see ua_service_foreach_users()
  */

diff --git a/include/user-awareness.h b/include/user-awareness.h
index b72d702622be7eb772a774c699fa0aee4f4f379c..9c7d05f843693c776612b0015b9016e08977f062 100755 (executable)
--- a/include/user-awareness.h
+++ b/include/user-awareness.h
@@ -212,7 +212,7 @@ int ua_monitor_add_sensor(
  * @return 0 on success, otherwise a negative error value
  * @retval #UA_ERROR_NONE Successful
  * @retval #UA_ERROR_PERMISSION_DENIED Permission Denied
- * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #UA_ERROR_INVALID_PARAMETER Invalid parameter or sensor not available to remove
  * @retval #UA_ERROR_NOT_PERMITTED Operation not permitted
  * @retval #UA_ERROR_ALREADY_DONE Already done
  * @retval #UA_ERROR_NOT_READY Resource not ready
@@ -663,11 +663,11 @@ int ua_user_remove_device(
  * @retval #UA_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #UA_ERROR_NOT_INITIALIZED Not initialized yet
  *
- * @see ua_registered_dev_cb()
+ * @see ua_registered_device_cb()
  */
 int ua_user_foreach_devices(
                ua_user_h user,
-               ua_registered_dev_cb foreach_cb,
+               ua_registered_device_cb foreach_cb,
                void *user_data);
 
 /**
@@ -1336,11 +1336,11 @@ int ua_device_get_by_device_id(
 
 /**
  * @ingroup CAPI_NETWORK_UA_MODULE
- * @brief Gets sensor's status.
+ * @brief Gets sensor's status report.
  * @since_tizen 6.5
  *
  * @param[in] sensor The sensor handle
- * @param[out] status The sensor's status.
+ * @param[out] report The sensor's status report.
  *
  * @return 0 on success, otherwise a negative error value
  * @retval #UA_ERROR_NONE Successful
@@ -1350,7 +1350,7 @@ int ua_device_get_by_device_id(
  */
 int ua_sensor_get_status(
                ua_sensor_h sensor,
-               ua_sensor_report_e *status);
+               ua_sensor_report_e *report);
 
 /**
  * @ingroup CAPI_NETWORK_UA_MODULE

diff --git a/src/user-awareness-device.c b/src/user-awareness-device.c
index 8928a14cc8e9e2c15d51839e1eb6f6686a83a298..275543853247c22d3635cdf0e3c7ca09b1033afa 100755 (executable)
--- a/src/user-awareness-device.c
+++ b/src/user-awareness-device.c
@@ -339,7 +339,7 @@ void _ua_handle_device_removed(int result, uam_device_info_s *uam_info)
 
 int _ua_foreach_devices_by_user(
                ua_user_h user_handle,
-               ua_registered_dev_cb foreach_cb,
+               ua_registered_device_cb foreach_cb,
                void *user_data)
 {
        FUNC_ENTRY;
@@ -1132,7 +1132,7 @@ int ua_device_clone(ua_device_h *cloned,
 }
 
 int ua_foreach_devices(
-               ua_registered_dev_cb foreach_cb,
+               ua_registered_device_cb foreach_cb,
                void *user_data)
 {
        FUNC_ENTRY;
@@ -1197,7 +1197,7 @@ done:
 
 int ua_device_foreach_added_by_user(
                ua_user_h user_handle,
-               ua_registered_dev_cb foreach_cb,
+               ua_registered_device_cb foreach_cb,
                void *user_data)
 {
        FUNC_ENTRY;

diff --git a/src/user-awareness-users.c b/src/user-awareness-users.c
index 971a1a034e2c968567c3645d621c2d2f25be257d..680f5a0fd212dbedbb0fe7ba2e663559b251c25a 100755 (executable)
--- a/src/user-awareness-users.c
+++ b/src/user-awareness-users.c
@@ -949,7 +949,7 @@ int ua_user_remove_device_by_device_id(
 
 int ua_user_foreach_devices(
                ua_user_h user_handle,
-               ua_registered_dev_cb foreach_cb,
+               ua_registered_device_cb foreach_cb,
                void *user_data)
 {
        FUNC_ENTRY;