From 875adef2e557d2f0caa36877ac3037cf7473d90d Mon Sep 17 00:00:00 2001 From: Shinwoo Kim Date: Thu, 18 Apr 2019 09:28:57 +0900 Subject: [PATCH] doc: follow document policy for deprecated API (1) The @deprecated should come first than other information. (2) The @brief should follow just after @deprecated (3) Use correct version information for ACR Change-Id: Ia7bc8469bd89449fef80ca6ac284ec39bf0b589c --- src/lib/ecore_input/Ecore_Input.h | 14 ++++++-------- src/lib/elementary/elm_deprecated.h | 14 +++++--------- 2 files changed, 11 insertions(+), 17 deletions(-) diff --git a/src/lib/ecore_input/Ecore_Input.h b/src/lib/ecore_input/Ecore_Input.h index 62dbf64..a25e9b6 100644 --- a/src/lib/ecore_input/Ecore_Input.h +++ b/src/lib/ecore_input/Ecore_Input.h @@ -520,7 +520,9 @@ extern "C" { // //TIZEN_ONLY(20170307) Deprecate ecore_input_joystick_init/shutdown API /** - * Initializes the Ecore Input Joystick system. + * @deprecated Deprecated since Tizen 5.5 + * @brief Initializes the Ecore Input Joystick system. + * ecore_event_init calls this by default. * * @return How many times the lib has been initialized. * @@ -529,13 +531,12 @@ extern "C" { * @if MOBILE @since_tizen 2.4 * @elseif WEARABLE @since_tizen 3.0 * @endif - * - * @deprecated Deprecated since Tizen 4.0 - * ecore_event_init calls this by default */ EINA_DEPRECATED EAPI int ecore_input_joystick_init(void); /** - * Shutdowns the Ecore Input Joystick system. + * @deprecated Deprecated since Tizen 5.5 + * @brief Shutdowns the Ecore Input Joystick system. + * ecore_event_shutdown calls this by default. * * @return How many times the lib has been initialized. * @@ -544,9 +545,6 @@ extern "C" { * @if MOBILE @since_tizen 2.4 * @elseif WEARABLE @since_tizen 3.0 * @endif - * - * @deprecated Deprecated since Tizen 4.0 - * ecore_event_shutdown calls this by default */ EINA_DEPRECATED EAPI int ecore_input_joystick_shutdown(void); // diff --git a/src/lib/elementary/elm_deprecated.h b/src/lib/elementary/elm_deprecated.h index 115e782..b3a6603 100644 --- a/src/lib/elementary/elm_deprecated.h +++ b/src/lib/elementary/elm_deprecated.h @@ -1677,14 +1677,15 @@ EINA_DEPRECATED EAPI void elm_access_external_info_set(Evas_Object *obj, const c EINA_DEPRECATED EAPI char *elm_access_external_info_get(const Evas_Object *obj); /** - * @deprecated Deprecated since 2.4. - * @ingroup Elm_Ctxpopup + * @deprecated Deprecated since 5.5 + * @brief Get the direction priority of a ctxpopup. * * @param[in] obj The object. * @param[in] direction The direction to check available to show ctxpopup. - * * @return EINA_TRUE if object is available to show with @p direction. * + * @ingroup Elm_Ctxpopup + * * @if MOBILE @since_tizen 2.3 * @elseif WEARABLE @since_tizen 2.3.1 * @endif @@ -1699,20 +1700,15 @@ EINA_DEPRECATED EAPI void elm_win_name_set(Evas_Object *obj, const char *name); // TIZEN_ONLY(20160126) : add elm_win_profiles_set /** + * @deprecated Deprecated since Tizen 5.5 * @brief Sets the profile list of a window. * - * @if MOBILE @since_tizen 2.3 - * @elseif WEARABLE @since_tizen 2.3.1 - * @endif - * * @param[in] obj The window object * @param[in] profiles The list of profile names * @param[in] num_profiles The number of profile names * * @ingroup Elm_Win * - * @deprecated Deprecated since Tizen 2.4 - * * @if MOBILE @since_tizen 2.3 * @elseif WEARABLE @since_tizen 2.3.1 * @endif -- 2.7.4