From 13881d6b9843cdd6feb9ac2459fd47de57ce5336 Mon Sep 17 00:00:00 2001 From: "sooyeon.kim" Date: Wed, 19 Aug 2020 15:19:34 +0900 Subject: [PATCH] [ACR-1585][gesture][Fix descriptions in header files] - Fix dbus policy issue Change-Id: Iff9779e0a3e03e6aeda036b640c713f6eb24d113 Signed-off-by: sooyeon.kim --- doc/uix_gesture_doc.h | 2 +- include/gesture.h | 32 +++++++++++++++++++++----------- include/gesture_common.h | 2 +- packaging/capi-ui-gesture.conf | 14 ++++++-------- 4 files changed, 29 insertions(+), 21 deletions(-) diff --git a/doc/uix_gesture_doc.h b/doc/uix_gesture_doc.h index 042d0dd..54a528e 100644 --- a/doc/uix_gesture_doc.h +++ b/doc/uix_gesture_doc.h @@ -40,7 +40,7 @@ * * @section CAPI_UIX_GESTURE_MODULE_FEATURE Related Features * This API is related with the following features:
- * - http://tizen.org/feature/sensor.gesture_recognition
+ * - %http://tizen.org/feature/sensor.gesture_recognition
* It is recommended to design feature related codes in your application for reliability.
* You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.
* To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
diff --git a/include/gesture.h b/include/gesture.h index 6b4f13e..1171bd0 100644 --- 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 diff --git a/include/gesture_common.h b/include/gesture_common.h index 0aaf39a..a8954c6 100644 --- a/include/gesture_common.h +++ b/include/gesture_common.h @@ -51,11 +51,11 @@ typedef struct hand_gesture_data_s* hand_gesture_data_h; */ typedef enum { HAND_GESTURE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + HAND_GESTURE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ HAND_GESTURE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid function parameter */ HAND_GESTURE_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Function not implemented */ HAND_GESTURE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ HAND_GESTURE_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ - HAND_GESTURE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ HAND_GESTURE_ERROR_ALREADY_STARTED = TIZEN_ERROR_GESTURE | 0x01, /**< Recognition is already started */ HAND_GESTURE_ERROR_NOT_STARTED = TIZEN_ERROR_GESTURE | 0x02, /**< Recognition is not started */ HAND_GESTURE_ERROR_OPERATION_FAILED = TIZEN_ERROR_GESTURE | 0x04, /**< Operation failed because of a system error */ diff --git a/packaging/capi-ui-gesture.conf b/packaging/capi-ui-gesture.conf index d48278d..2514f02 100644 --- a/packaging/capi-ui-gesture.conf +++ b/packaging/capi-ui-gesture.conf @@ -1,17 +1,15 @@ - - - - - + + + - - + + - \ No newline at end of file + -- 2.7.4