From a801a755f95695b8c3418aed7440ea65e18cd406 Mon Sep 17 00:00:00 2001 From: Somin Kim Date: Fri, 16 Dec 2016 18:31:39 +0900 Subject: [PATCH] Doxygen modified Change-Id: I436c6f08c06fa41d5a6aa9682c2e7741e8386b46 Signed-off-by: Somin Kim --- include/activity_recognition.h | 102 ++++++++++++++++++++--------------------- include/gesture_recognition.h | 86 +++++++++++++++++----------------- 2 files changed, 94 insertions(+), 94 deletions(-) diff --git a/include/activity_recognition.h b/include/activity_recognition.h index e908d87..0f44788 100644 --- a/include/activity_recognition.h +++ b/include/activity_recognition.h @@ -33,19 +33,19 @@ extern "C" { #endif // __cplusplus /** - * @brief Handle for controlling the activity recognizer + * @brief The activity recognizer controlling handle. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef struct _activity_handle_s* activity_h; /** - * @brief Activity data handle delivered through activity_recognition_cb() + * @brief Delivery through activity_recognition_cb() of activity data handle. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef struct _activity_data_s* activity_data_h; /** - * @brief Error codes + * @brief Enumeration for error codes. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -61,7 +61,7 @@ typedef enum { } activity_error_e; /** - * @brief Activity types + * @brief Enumeration for activity types. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -72,7 +72,7 @@ typedef enum { } activity_type_e; /** - * @brief Recognition accuracy + * @brief Enumeration for recognition accuracy. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -107,16 +107,16 @@ typedef void(* activity_recognition_cb)(activity_type_e activity, const activity * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] activity Activity type to be checked. - * @param[out] supported @c true, if the activity is recognizable in the current device.@n - * @c false, otherwise. + * @param[in] activity Activity type to be checked + * @param[out] supported @c true if the activity is recognizable in the current device,@n + * @c false otherwise * - * @return 0 if the @c activity is supported, otherwise a negative error value. - * @retval #ACTIVITY_ERROR_NONE Supported. - * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used. - * @retval #ACTIVITY_ERROR_NOT_SUPPORTED The @c activity is not supported. - * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error. - * @retval #ACTIVITY_ERROR_PERMISSION_DENIED Does not have permission to use this. + * @return @c 0 if the @c activity is supported, otherwise a negative error value + * @retval #ACTIVITY_ERROR_NONE Supported + * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used + * @retval #ACTIVITY_ERROR_NOT_SUPPORTED The @c activity is not supported + * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error + * @retval #ACTIVITY_ERROR_PERMISSION_DENIED Does not have permission to use this */ int activity_is_supported(activity_type_e activity, bool* supported); @@ -125,13 +125,13 @@ int activity_is_supported(activity_type_e activity, bool* supported); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[out] handle Activity handle to be initialized. + * @param[out] handle Activity handle to be initialized * - * @return 0 on success, otherwise a negative error value. - * @retval #ACTIVITY_ERROR_NONE Successful. - * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used. - * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported. - * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error, e.g., out of memory. + * @return @c 0 on success, otherwise a negative error value + * @retval #ACTIVITY_ERROR_NONE Successful + * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used + * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported + * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error, e.g., out of memory * * @see activity_release() */ @@ -142,13 +142,13 @@ int activity_create(activity_h *handle); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] handle Activity handle to be released. + * @param[in] handle Activity handle to be released * - * @return 0 on success, otherwise a negative error value. - * @retval #ACTIVITY_ERROR_NONE Successful. - * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used. - * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported. - * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error. + * @return @c 0 on success, otherwise a negative error value + * @retval #ACTIVITY_ERROR_NONE Successful + * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used + * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported + * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error * * @pre activity_create() */ @@ -161,18 +161,18 @@ int activity_release(activity_h handle); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] handle Activity handle to be used to control the activity event. - * @param[in] activity Activity type to be monitored. - * @param[in] callback Callback function to receive activity events. - * @param[in] user_data User data to be passed to the callback function. + * @param[in] handle Activity handle to be used to control the activity event + * @param[in] activity Activity type to be monitored + * @param[in] callback Callback function to receive activity events + * @param[in] user_data User data to be passed to the callback function * - * @return 0 on success, otherwise a negative error value. - * @retval #ACTIVITY_ERROR_NONE Successful. - * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used. - * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported. - * @retval #ACTIVITY_ERROR_ALREADY_STARTED The @c handle is being used already. - * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error. - * @retval #ACTIVITY_ERROR_PERMISSION_DENIED Does not have permission to use this. + * @return @c 0 on success, otherwise a negative error value + * @retval #ACTIVITY_ERROR_NONE Successful + * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used + * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported + * @retval #ACTIVITY_ERROR_ALREADY_STARTED The @c handle is being used already + * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error + * @retval #ACTIVITY_ERROR_PERMISSION_DENIED Does not have permission to use this * * @pre activity_create() * @post activity_recognition_cb() @@ -185,14 +185,14 @@ int activity_start_recognition(activity_h handle, activity_type_e activity, acti * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] handle Activity handle to release its callback function registered. + * @param[in] handle Activity handle to release its callback function registered * - * @return 0 on success, otherwise a negative error value. - * @retval #ACTIVITY_ERROR_NONE Successful. - * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used. - * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported. - * @retval #ACTIVITY_ERROR_NOT_STARTED Nothing is started using the @c handle. - * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error. + * @return @c 0 on success, otherwise a negative error value + * @retval #ACTIVITY_ERROR_NONE Successful + * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used + * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported + * @retval #ACTIVITY_ERROR_NOT_STARTED Nothing is started using the @c handle + * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error */ int activity_stop_recognition(activity_h handle); @@ -201,14 +201,14 @@ int activity_stop_recognition(activity_h handle); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] data Activity data received through activity_cb(). - * @param[out] accuracy Accuracy. + * @param[in] data Activity data received through activity_cb() + * @param[out] accuracy Accuracy * - * @return 0 on success, otherwise a negative error value. - * @retval #ACTIVITY_ERROR_NONE Successful. - * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used. - * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported. - * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error. + * @return @c 0 on success, otherwise a negative error value + * @retval #ACTIVITY_ERROR_NONE Successful + * @retval #ACTIVITY_ERROR_INVALID_PARAMETER Invalid parameter used + * @retval #ACTIVITY_ERROR_NOT_SUPPORTED Activity recognition is not supported + * @retval #ACTIVITY_ERROR_OPERATION_FAILED Operation failed because of a system error */ int activity_get_accuracy(const activity_data_h data, activity_accuracy_e *accuracy); diff --git a/include/gesture_recognition.h b/include/gesture_recognition.h index 65b3f2a..c0cfd1a 100644 --- a/include/gesture_recognition.h +++ b/include/gesture_recognition.h @@ -33,19 +33,19 @@ extern "C" { #endif // __cplusplus /** - * @brief Handle for controlling the gesture recognizer + * @brief The gesture recognizer controlling handle. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef struct _gesture_handle_s* gesture_h; /** - * @brief Gesture data handle delivered through gesture_recognition_cb() + * @brief Delivery through gesture_recognition_cb() of gesture data handle. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef struct _gesture_data_s* gesture_data_h; /** - * @brief Error codes + * @brief Enumeration for error codes. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -61,7 +61,7 @@ typedef enum { } gesture_error_e; /** - * @brief Gesture types + * @brief Enumeration for gesture types. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -77,7 +77,7 @@ typedef enum { } gesture_type_e; /** - * @brief Gesture recognition option + * @brief Enumeration for gesture recognition option. * @details If the default option is used, the system tries to reduce power consumption. * For example, the recognition engine may stop detecting gestures if the display is turned off. * Using #GESTURE_OPTION_ALWAYS_ON disables such power-saving functionalities. @@ -136,10 +136,10 @@ 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[out] supported @c true, if the gesture is recognizable in the current device.@n - * @c false, otherwise. + * @param[out] supported @c true if the gesture is recognizable in the current device,@n + * @c false otherwise. * - * @return 0 if the @c gesture is supported, otherwise a negative error value. + * @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. @@ -153,13 +153,13 @@ int gesture_is_supported(gesture_type_e gesture, bool* supported); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[out] handle Gesture handle to be initialized. + * @param[out] handle Gesture handle to be initialized * - * @return 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_OPERATION_FAILED Operation failed because of a system error, e.g., out of memory. + * @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_OPERATION_FAILED Operation failed because of a system error, e.g., out of memory * * @see gesture_release() */ @@ -170,13 +170,13 @@ int gesture_create(gesture_h *handle); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] handle Gesture handle to be released. + * @param[in] handle Gesture handle to be released * - * @return 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_OPERATION_FAILED Operation failed because of a system error. + * @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_OPERATION_FAILED Operation failed because of a system error * * @pre gesture_create() */ @@ -195,7 +195,7 @@ int gesture_release(gesture_h handle); * @param[in] callback Callback function to receive gesture events. * @param[in] user_data User data to be passed to the callback function. * - * @return 0 on success, otherwise a negative error value. + * @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. @@ -214,14 +214,14 @@ int gesture_start_recognition(gesture_h handle, gesture_type_e gesture, gesture_ * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] handle Gesture handle to release its callback function registered. + * @param[in] handle Gesture handle to release its callback function registered * - * @return 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_NOT_STARTED Nothing is started using the @c handle. - * @retval #GESTURE_ERROR_OPERATION_FAILED Operation failed because of a system error. + * @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_NOT_STARTED Nothing is started using the @c handle + * @retval #GESTURE_ERROR_OPERATION_FAILED Operation failed because of a system error */ int gesture_stop_recognition(gesture_h handle); @@ -230,14 +230,14 @@ int gesture_stop_recognition(gesture_h handle); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] data Gesture data received through a callback function. - * @param[out] event Gesture event data. + * @param[in] data Gesture data received through a callback function + * @param[out] event Gesture event data * - * @return 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_OPERATION_FAILED Operation failed because of a system error. + * @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_OPERATION_FAILED Operation failed because of a system error */ int gesture_get_event(const gesture_data_h data, gesture_event_e *event); @@ -246,15 +246,15 @@ int gesture_get_event(const gesture_data_h data, gesture_event_e *event); * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * - * @param[in] data Tilt gesture data received through a callback function. - * @param[out] x Tilting degree on X-axis. - * @param[out] y Tilting degree on Y-axis. + * @param[in] data Tilt gesture data received through a callback function + * @param[out] x Tilting degree on X-axis + * @param[out] y Tilting degree on Y-axis * - * @return 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_OPERATION_FAILED Operation failed because of a system error. + * @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_OPERATION_FAILED Operation failed because of a system error */ int gesture_get_tilt(const gesture_data_h data, int *x, int *y); -- 2.7.4