From: Somin Kim Date: Thu, 12 Jan 2017 07:12:57 +0000 (+0900) Subject: Doxygen update X-Git-Tag: submit/tizen/20170222.014246~1^2~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d75b7b6b0e8a51c28756c81ddee7b255da6c16b3;p=platform%2Fcore%2Fapi%2Fmotion.git Doxygen update Change-Id: I2d90a6072574bdae737850f31059ccd3dfa907b8 Signed-off-by: Somin Kim --- diff --git a/include/gesture_recognition.h b/include/gesture_recognition.h index d24fba2..ae3bc02 100644 --- a/include/gesture_recognition.h +++ b/include/gesture_recognition.h @@ -114,7 +114,7 @@ typedef enum { * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] gesture Gesture type detected. + * @param[in] gesture Gesture type detected * @param[in] data Detailed information of the detected gesture.@n * gesture_get_event() or gesture_get_tilt() * can be used to extract the information from @c data. @@ -124,7 +124,7 @@ typedef enum { * #GESTURE_ERROR_NOT_SUPPORTED, if the gesture is not supported in the current profile.@n * #GESTURE_ERROR_OPERATION_FAILED, if the operation failed because of a system error.@n * #GESTURE_ERROR_PERMISSION_DENIED, if the application has no permission to use this. - * @param[in] user_data The user data had passed to gesture_start_recognition(). + * @param[in] user_data The user data had passed to gesture_start_recognition() * * @pre gesture_start_recognition() */ @@ -136,16 +136,16 @@ typedef void(* gesture_recognition_cb)(gesture_type_e gesture, const gesture_dat * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] gesture Gesture type to be checked. + * @param[in] gesture Gesture type to be checked * @param[out] supported @c true if the gesture is recognizable in the current device,@n - * @c false otherwise. - * - * @return @c 0 if the @c gesture is supported, otherwise a negative error value. - * @retval #GESTURE_ERROR_NONE Supported. - * @retval #GESTURE_ERROR_INVALID_PARAMETER Invalid parameter used. - * @retval #GESTURE_ERROR_NOT_SUPPORTED The @c gesture is not supported. - * @retval #GESTURE_ERROR_OPERATION_FAILED Operation failed because of a system error. - * @retval #GESTURE_ERROR_PERMISSION_DENIED Does not have permission to use this. + * @c false otherwise + * + * @return @c 0 if the @c gesture is supported, otherwise a negative error value + * @retval #GESTURE_ERROR_NONE Supported + * @retval #GESTURE_ERROR_INVALID_PARAMETER Invalid parameter used + * @retval #GESTURE_ERROR_NOT_SUPPORTED The @c gesture is not supported + * @retval #GESTURE_ERROR_OPERATION_FAILED Operation failed because of a system error + * @retval #GESTURE_ERROR_PERMISSION_DENIED Does not have permission to use this */ int gesture_is_supported(gesture_type_e gesture, bool* supported); @@ -190,19 +190,19 @@ int gesture_release(gesture_h handle); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] handle Gesture handle to be used to control the gesture event. - * @param[in] gesture Gesture type to be monitored. It should be one of #gesture_type_e. - * @param[in] option Detection option. It should be one of #gesture_option_e. - * @param[in] callback Callback function to receive gesture events. - * @param[in] user_data User data to be passed to the callback function. - * - * @return @c 0 on success, otherwise a negative error value. - * @retval #GESTURE_ERROR_NONE Successful. - * @retval #GESTURE_ERROR_INVALID_PARAMETER Invalid parameter used. - * @retval #GESTURE_ERROR_NOT_SUPPORTED Gesture recognition is not supported. - * @retval #GESTURE_ERROR_ALREADY_STARTED The @c handle is being used already. - * @retval #GESTURE_ERROR_OPERATION_FAILED Operation failed because of a system error. - * @retval #GESTURE_ERROR_PERMISSION_DENIED Does not have permission to use this. + * @param[in] handle Gesture handle to be used to control the gesture event + * @param[in] gesture Gesture type to be monitored + * @param[in] option Detection option + * @param[in] callback Callback function to receive gesture events + * @param[in] user_data User data to be passed to the callback function + * + * @return @c 0 on success, otherwise a negative error value + * @retval #GESTURE_ERROR_NONE Successful + * @retval #GESTURE_ERROR_INVALID_PARAMETER Invalid parameter used + * @retval #GESTURE_ERROR_NOT_SUPPORTED Gesture recognition is not supported + * @retval #GESTURE_ERROR_ALREADY_STARTED The @c handle is being used already + * @retval #GESTURE_ERROR_OPERATION_FAILED Operation failed because of a system error + * @retval #GESTURE_ERROR_PERMISSION_DENIED Does not have permission to use this * * @pre gesture_create() * @post gesture_recognition_cb()