[ACR-1585][gesture][Fix descriptions in header files]

[platform/core/api/gesture.git] / include / gesture.h

diff --git a/include/gesture.h b/include/gesture.h
index 6b4f13e..1171bd0 100644 (file)
--- a/include/gesture.h
+++ b/include/gesture.h
@@ -41,6 +41,11 @@ typedef struct hand_gesture_s *hand_gesture_h;
 
 /**
  * @brief Called when a gesture is detected.
+ * @details Following error codes can be delivered: \n
+ *          #HAND_GESTURE_ERROR_NONE, \n
+ *          #HAND_GESTURE_ERROR_NOT_SUPPORTED, \n
+ *          #HAND_GESTURE_ERROR_INVALID_PARAMETER, \n
+ *          #HAND_GESTURE_ERROR_OPERATION_FAILED
  *
  * @since_tizen @if WEARABLE 6.0 @endif
  * @remarks The @a handle is managed by the platform and will be released when hand_gesture_destroy() is called.
@@ -48,11 +53,11 @@ typedef struct hand_gesture_s *hand_gesture_h;
  * @param[in] handle     A gesture handle
  * @param[in] gesture    A gesture type detected
  * @param[in] timestamp  The time when the gesture is detected. Epoch time in seconds.
- * @param[in] error      An error value. It can be one of the following error values:@n
- *                       #HAND_GESTURE_ERROR_NONE, if the operation succeeded.@n
- *                       #HAND_GESTURE_ERROR_NOT_SUPPORTED, if the gesture is not supported in the current profile.@n
- *                       #HAND_GESTURE_ERROR_OPERATION_FAILED, if the operation failed because of a system error.@n
- *                       #HAND_GESTURE_ERROR_PERMISSION_DENIED, if the application has no permission to use this.
+ * @param[in] error      An error value. It can be one of the following error values: \n
+ *                       #HAND_GESTURE_ERROR_NONE, if the operation succeeded.\n
+ *                       #HAND_GESTURE_ERROR_NOT_SUPPORTED, if the gesture is not supported on the device.\n
+ *                       #HAND_GESTURE_ERROR_INVALID_PARAMETER, if the parameter is invalid. \n
+ *                       #HAND_GESTURE_ERROR_OPERATION_FAILED, if the operation failed because of a system error.
  * @param[in] user_data  The user data is passed to hand_gesture_start_recognition()
  *
  * @see hand_gesture_start_recognition()
@@ -61,6 +66,11 @@ typedef void(* hand_gesture_recognition_cb)(hand_gesture_h handle, hand_gesture_
 
 /**
  * @brief Called when an error is occurred.
+ * @details Following error codes can be delivered: \n
+ *          #HAND_GESTURE_ERROR_INVALID_PARAMETER, \n
+ *          #HAND_GESTURE_ERROR_INVALID_OPERATION, \n
+ *          #HAND_GESTURE_ERROR_OUT_OF_MEMORY, \n
+ *          #HAND_GESTURE_ERROR_OPERATION_FAILED
  *
  * @since_tizen @if WEARABLE 6.0 @endif
  * @remarks The @a handle is the same object for which the callback was set.
@@ -68,10 +78,10 @@ typedef void(* hand_gesture_recognition_cb)(hand_gesture_h handle, hand_gesture_
  *          The @a msg is managed by the platform and will be released when invoking this callback function is finished.
  *
  * @param[in] handle     A gesture handle
- * @param[in] error      An error value. It can be one of the following error values: @n
- *                       #HAND_GESTURE_ERROR_INVALID_PARAMETER,
- *                       #HAND_GESTURE_ERROR_INVALID_OPERATION,
- *                       #HAND_GESTURE_ERROR_OUT_OF_MEMORY,
+ * @param[in] error      An error value. It can be one of the following error values: \n
+ *                       #HAND_GESTURE_ERROR_INVALID_PARAMETER, \n
+ *                       #HAND_GESTURE_ERROR_INVALID_OPERATION, \n
+ *                       #HAND_GESTURE_ERROR_OUT_OF_MEMORY, \n
  *                       #HAND_GESTURE_ERROR_OPERATION_FAILED
  * @param[in] msg        An error message from gesture engine service
  * @param[in] user_data  The user data is passed to hand_gesture_set_error_cb()
@@ -83,13 +93,13 @@ typedef void(* hand_gesture_error_cb)(hand_gesture_h handle, hand_gesture_error_
 
 /**
  * @brief Checks whether a gesture is supported or not.
- * @details Check if the given gesture type is supported in the current device.
+ * @details Check if the given gesture type is supported on the device.
  *
  * @since_tizen @if WEARABLE 6.0 @endif
  *
  * @param[in] handle      A gesture handle
  * @param[in] gesture     A gesture type to be checked
- * @param[out] supported  @c true if the gesture is recognizable in the current device,@n
+ * @param[out] supported  @c true if the gesture is recognizable on the device,\n
  *                        @c false otherwise
  *
  * @return @c 0 if the @c gesture is supported, otherwise a negative error value