Update description of user callbacks to the doxygen commentssubmit/tizen/20191007.022831accepted/tizen/unified/20191007.234842

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

1 files changed, 14 insertions, 4 deletions

diff --git a/include/user-awareness.h b/include/user-awareness.h
index 7f3134b..c4a1394 100644
--- a/include/user-awareness.h
+++ b/include/user-awareness.h
@@ -357,6 +357,8 @@ typedef void (*ua_scan_completed_cb)(
  *
  * @remarks The @a handle should not be released.
  * @remarks The @a handle can be used only in the callback.
+ * @remarks The @a sensor_handle should not be released.
+ * @remarks The @a sensor_handle can be used only in the callback.
  *
  * @param[in] result The result of the requested operation.
  * @param[in] handle The monitor handle
@@ -365,7 +367,7 @@ typedef void (*ua_scan_completed_cb)(
  *  reported user presence before invoking callback.
  * @param[in] device_handle The first device handle on which sensor is detected.
  * @param[in] sensor_info The sensor info for the detected sensor.
- * @param[in] user_data The user data passed in ua_monitor_start_absence_detection()
+ * @param[in] user_data The user data passed in ua_monitor_start_presence_detection()
  *
  * @exception
  * @pre
@@ -388,6 +390,8 @@ typedef void (*ua_presence_detected_cb)(
  *
  * @remarks The @a handle should not be released.
  * @remarks The @a handle can be used only in the callback.
+ * @remarks The @a sensor_handle should not be released.
+ * @remarks The @a sensor_handle can be used only in the callback.
  *
  * @param[in] result The result of the requested operation.
  * @param[in] handle The monitor handle with which absence detection start was invoked. \n
@@ -395,7 +399,7 @@ typedef void (*ua_presence_detected_cb)(
  *  In case monitor has more than one sensor and detection mode is not
  *  #UA_DETECT_MODE_ANY_SENSOR, sensor will be set to #UA_SENSOR_MAX before
  *  invoking callback.
- * @param[in] sensor_handle The sensor info for the detected sensor.
+ * @param[in] sensor_handle The sensor handle for the detected sensor.
  * @param[in] user_data The user data passed in ua_monitor_start_absence_detection()
  *
  * @exception
@@ -420,6 +424,8 @@ typedef void (*ua_absence_detected_cb)(
  * @remarks The @a handle can be used only in the callback.
  * @remarks The @a user_handle should not be released.
  * @remarks The @a user_handle can be used only in the callback.
+ * @remarks The @a sensor_handles should not be released.
+ * @remarks The @a sensor_handles can be used only in the callback.
  *
  * @param[in] result The result of the requested operation.
  * @param[in] handle The monitor handle with which absence detection start was invoked.
@@ -427,6 +433,7 @@ typedef void (*ua_absence_detected_cb)(
  *   In case monitor has more than one sensor and detection mode is not
  *   #UA_DETECT_MODE_ANY_SENSOR, sensor will be set to #UA_SENSOR_MAX before invoking
  *   callback.
+ * @param[in] sensor_handles The list of sensor handles on which user is not detected.
  * @param[in] user_data  The user data passed in ua_monitor_set_user_absence_detected_cb()
  *
  * @exception
@@ -439,7 +446,7 @@ typedef void (*ua_absence_user_detected_cb)(
 		int result,
 		ua_monitor_h handle,
 		ua_user_h user_handle,
-		GSList *sensor_handle,
+		GSList *sensor_handles,
 		void *user_data);
 
 /**
@@ -453,11 +460,14 @@ typedef void (*ua_absence_user_detected_cb)(
  * @remarks The @a user_handle can be used only in the callback.
  * @remarks The @a device_handles should not be released.
  * @remarks The @a device_handles can be used only in the callback.
+ * @remarks The @a sensor_handles should not be released.
+ * @remarks The @a sensor_handles can be used only in the callback.
  *
  * @param[in] result The result of the requested operation.
  * @param[in] handle The monitor handle with which presence detection start was invoked.
  * @param[in] user_handle The user handle to detected user's information.
  * @param[in] device_handles The list of device handles on which user is detected.
+ * @param[in] sensor_handles The list of sensor handles on which user is detected.
  * @param[in] user_data  The user data passed in ua_monitor_set_user_presence_detected_cb()
  *
  * @exception
@@ -471,7 +481,7 @@ typedef void (*ua_presence_user_detected_cb)(
 		ua_monitor_h handle,
 		ua_user_h user_handle,
 		GSList *device_handles,
-		GSList *sensor_handle,
+		GSList *sensor_handles,
 		void *user_data);
 
 /**