From 577977886ee6a581e31f40e6b36ae561cfc7742e Mon Sep 17 00:00:00 2001 From: "Myoungwoon Roy, Kim" Date: Fri, 10 Jul 2020 09:27:35 +0900 Subject: [PATCH] docs: Correct the wrong group name in access, mapbuf, object, popup and win Change-Id: I70e6baa59453f97c439a1f80f5743c441cfb5f61 --- src/lib/elementary/efl_access_text.h | 4 ++++ src/lib/elementary/elm_access.h | 4 ++-- src/lib/elementary/elm_atspi_bridge_eo.legacy.h | 7 ++++--- src/lib/elementary/elm_mapbuf.h | 2 +- src/lib/elementary/elm_object.h | 26 +++++++++++------------ src/lib/elementary/elm_object_item.h | 12 +++++------ src/lib/elementary/elm_popup_eo.legacy.h | 28 ++++++++++++------------- src/lib/elementary/elm_win_legacy.h | 16 +++++++------- 8 files changed, 52 insertions(+), 47 deletions(-) diff --git a/src/lib/elementary/efl_access_text.h b/src/lib/elementary/efl_access_text.h index 760784c..eb28325 100644 --- a/src/lib/elementary/efl_access_text.h +++ b/src/lib/elementary/efl_access_text.h @@ -17,11 +17,15 @@ // /** + * @internal + * * @brief Free Efl_Access_Text_Attribute structure */ EAPI void elm_atspi_text_text_attribute_free(Efl_Access_Text_Attribute *attr); /** + * @internal + * * @brief Free Efl_Access_Text_Range structure */ EAPI void elm_atspi_text_text_range_free(Efl_Access_Text_Range *range); diff --git a/src/lib/elementary/elm_access.h b/src/lib/elementary/elm_access.h index 20aaf1b..10b1a4d 100644 --- a/src/lib/elementary/elm_access.h +++ b/src/lib/elementary/elm_access.h @@ -1,6 +1,6 @@ /** - * @defgroup Elm_Access Access - * @ingroup elm_accessibility_group + * @defgroup Access Access + * @ingroup Elementary */ enum _Elm_Access_Info_Type diff --git a/src/lib/elementary/elm_atspi_bridge_eo.legacy.h b/src/lib/elementary/elm_atspi_bridge_eo.legacy.h index ec6b3ce..387dcbb 100644 --- a/src/lib/elementary/elm_atspi_bridge_eo.legacy.h +++ b/src/lib/elementary/elm_atspi_bridge_eo.legacy.h @@ -15,10 +15,10 @@ typedef Eo Elm_Atspi_Bridge; #endif /** - * @brief Indicate if connection with AT-SPI2 bus has been established. - * * @internal * + * @brief Indicate if connection with AT-SPI2 bus has been established. + * * @param[in] obj The object. * * @return @c true if connection has been established, @c false otherwise @@ -28,9 +28,10 @@ typedef Eo Elm_Atspi_Bridge; EAPI Eina_Bool elm_atspi_bridge_connected_get(const Elm_Atspi_Bridge *obj); /** + * @internal + * * @brief Get root object of accessible object hierarchy * - * @internal * @param[in] obj The object. * * @ingroup Elm_Atspi_Bridge_Group diff --git a/src/lib/elementary/elm_mapbuf.h b/src/lib/elementary/elm_mapbuf.h index 2ba4c2c..7c64bcc 100644 --- a/src/lib/elementary/elm_mapbuf.h +++ b/src/lib/elementary/elm_mapbuf.h @@ -1,5 +1,5 @@ /** - * @defgroup Elm_Mapbuf_Group Mapbu + * @defgroup Elm_Mapbuf_Group Mapbuf * @ingroup Elementary * * @image html mapbuf_inheritance_tree.png diff --git a/src/lib/elementary/elm_object.h b/src/lib/elementary/elm_object.h index fbe1e84..515bd6c 100644 --- a/src/lib/elementary/elm_object.h +++ b/src/lib/elementary/elm_object.h @@ -215,7 +215,7 @@ EAPI Evas_Object *elm_object_part_access_register(Evas_Object *obj, const char * * @param obj The object * @param part The object's part name to get access object * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 4.0 * @elseif WEARABLE @since_tizen 3.0 @@ -693,7 +693,7 @@ EAPI const char* elm_object_scroll_item_valign_get(const Evas_Object *obj); * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -715,7 +715,7 @@ EAPI Eina_Bool elm_color_class_color_set(const char *color_class, int r, * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -738,7 +738,7 @@ EAPI Eina_Bool elm_color_class_color_get(const char *color_class, int *r, * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -761,7 +761,7 @@ EAPI Eina_Bool elm_color_class_color2_set(const char *color_class, int r, * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -784,7 +784,7 @@ EAPI Eina_Bool elm_color_class_color2_get(const char *color_class, int *r * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -807,7 +807,7 @@ EAPI Eina_Bool elm_color_class_color3_set(const char *color_class, int r, * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -847,7 +847,7 @@ EAPI void elm_color_class_del(const char *color_class); * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -869,7 +869,7 @@ EAPI Eina_Bool elm_object_color_class_color_set(Evas_Object *obj, const c * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -893,7 +893,7 @@ EAPI Eina_Bool elm_object_color_class_color_get(Evas_Object *obj, const c * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -917,7 +917,7 @@ EAPI Eina_Bool elm_object_color_class_color2_set(Evas_Object *obj, const * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -941,7 +941,7 @@ EAPI Eina_Bool elm_object_color_class_color2_get(Evas_Object *obj, const * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -965,7 +965,7 @@ EAPI Eina_Bool elm_object_color_class_color3_set(Evas_Object *obj, const * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 diff --git a/src/lib/elementary/elm_object_item.h b/src/lib/elementary/elm_object_item.h index 928c935..f149016 100644 --- a/src/lib/elementary/elm_object_item.h +++ b/src/lib/elementary/elm_object_item.h @@ -102,7 +102,7 @@ EAPI void elm_object_item_del(Elm_Object_Item *obj); * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -124,7 +124,7 @@ EAPI Eina_Bool elm_object_item_color_class_color_set(Elm_Object_Item *it, * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -148,7 +148,7 @@ EAPI Eina_Bool elm_object_item_color_class_color_get(Elm_Object_Item *it, * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -172,7 +172,7 @@ EAPI Eina_Bool elm_object_item_color_class_color2_set(Elm_Object_Item *it * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -196,7 +196,7 @@ EAPI Eina_Bool elm_object_item_color_class_color2_get(Elm_Object_Item *it * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 @@ -220,7 +220,7 @@ EAPI Eina_Bool elm_object_item_color_class_color3_set(Elm_Object_Item *it * * @since 1.19 * - * @ingroup General + * @ingroup Elm_General * * @if MOBILE @since_tizen 3.0 * @elseif WEARABLE @since_tizen 3.0 diff --git a/src/lib/elementary/elm_popup_eo.legacy.h b/src/lib/elementary/elm_popup_eo.legacy.h index 103c668..a02e667 100644 --- a/src/lib/elementary/elm_popup_eo.legacy.h +++ b/src/lib/elementary/elm_popup_eo.legacy.h @@ -55,7 +55,7 @@ typedef enum * * @since 1.9 * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI void elm_popup_align_set(Elm_Popup *obj, double horizontal, double vertical); @@ -68,7 +68,7 @@ EAPI void elm_popup_align_set(Elm_Popup *obj, double horizontal, double vertical * * @since 1.9 * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI void elm_popup_align_get(const Elm_Popup *obj, double *horizontal, double *vertical); @@ -83,7 +83,7 @@ EAPI void elm_popup_align_get(const Elm_Popup *obj, double *horizontal, double * * @param[in] obj The object. * @param[in] allow If @c true, events are passed to lower objects. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI void elm_popup_allow_events_set(Elm_Popup *obj, Eina_Bool allow); @@ -94,7 +94,7 @@ EAPI void elm_popup_allow_events_set(Elm_Popup *obj, Eina_Bool allow); * * @return If @c true, events are passed to lower objects. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI Eina_Bool elm_popup_allow_events_get(const Elm_Popup *obj); @@ -105,7 +105,7 @@ EAPI Eina_Bool elm_popup_allow_events_get(const Elm_Popup *obj); * @param[in] obj The object. * @param[in] wrap Wrapping type of type Elm_Wrap_Type. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI void elm_popup_content_text_wrap_type_set(Elm_Popup *obj, Elm_Wrap_Type wrap); @@ -117,7 +117,7 @@ EAPI void elm_popup_content_text_wrap_type_set(Elm_Popup *obj, Elm_Wrap_Type wra * * @return Wrapping type of type Elm_Wrap_Type. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI Elm_Wrap_Type elm_popup_content_text_wrap_type_get(const Elm_Popup *obj); @@ -130,7 +130,7 @@ EAPI Elm_Wrap_Type elm_popup_content_text_wrap_type_get(const Elm_Popup *obj); * @param[in] obj The object. * @param[in] orient The orientation of the popup. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI void elm_popup_orient_set(Elm_Popup *obj, Elm_Popup_Orient orient); @@ -141,7 +141,7 @@ EAPI void elm_popup_orient_set(Elm_Popup *obj, Elm_Popup_Orient orient); * * @return The orientation of the popup. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI Elm_Popup_Orient elm_popup_orient_get(const Elm_Popup *obj); @@ -162,7 +162,7 @@ EAPI Elm_Popup_Orient elm_popup_orient_get(const Elm_Popup *obj); * @param[in] obj The object. * @param[in] timeout The timeout in seconds. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI void elm_popup_timeout_set(Elm_Popup *obj, double timeout); @@ -173,7 +173,7 @@ EAPI void elm_popup_timeout_set(Elm_Popup *obj, double timeout); * * @return The timeout in seconds. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI double elm_popup_timeout_get(const Elm_Popup *obj); @@ -187,7 +187,7 @@ EAPI double elm_popup_timeout_get(const Elm_Popup *obj); * * @since 1.15.1 * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI void elm_popup_scrollable_set(Elm_Popup *obj, Eina_Bool scroll); @@ -202,7 +202,7 @@ EAPI void elm_popup_scrollable_set(Elm_Popup *obj, Eina_Bool scroll); * * @since 1.15.1 * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI Eina_Bool elm_popup_scrollable_get(const Elm_Popup *obj); @@ -224,7 +224,7 @@ EAPI Eina_Bool elm_popup_scrollable_get(const Elm_Popup *obj); * * @return A handle to the item added or @c null on errors. * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI Elm_Widget_Item *elm_popup_item_append(Elm_Popup *obj, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data); @@ -232,7 +232,7 @@ EAPI Elm_Widget_Item *elm_popup_item_append(Elm_Popup *obj, const char *label, E * * @since 1.17 * - * @ingroup Elm_Popup + * @ingroup Elm_Popup_Group */ EAPI void elm_popup_dismiss(Elm_Popup *obj); diff --git a/src/lib/elementary/elm_win_legacy.h b/src/lib/elementary/elm_win_legacy.h index 5d242de..f40cfd9 100644 --- a/src/lib/elementary/elm_win_legacy.h +++ b/src/lib/elementary/elm_win_legacy.h @@ -1185,7 +1185,7 @@ EAPI Ecore_Window elm_win_window_id_get(const Evas_Object *obj); * * @param obj The window object * - * @ingroup Elm_Win + * @ingroup Elm_Win_Group * @see elm_win_precreated_object_get() * @since Tizen 2.4 */ @@ -1198,7 +1198,7 @@ EAPI void elm_win_precreated_object_set(Evas_Object *obj); * * @return The precreated window object * - * @ingroup Elm_Win + * @ingroup Elm_Win_Group * @see elm_win_precreated_object_set() * @since Tizen 2.4 */ @@ -1323,7 +1323,7 @@ EAPI Eina_Bool elm_win_focus_get(const Elm_Win *obj); * * @param[in] style The style or @c null if none. * - * @ingroup Efl_Ui_Win + * @ingroup Elm_Win_Group */ EAPI Eina_Bool elm_win_focus_highlight_style_set(Elm_Win *obj, const char *style); @@ -1332,7 +1332,7 @@ EAPI Eina_Bool elm_win_focus_highlight_style_set(Elm_Win *obj, const char *style * * @return The style or @c null if none. * - * @ingroup Efl_Ui_Win + * @ingroup Elm_Win_Group */ EAPI const char *elm_win_focus_highlight_style_get(const Elm_Win *obj); @@ -1344,7 +1344,7 @@ EAPI const char *elm_win_focus_highlight_style_get(const Elm_Win *obj); * * @param[in] enabled The enabled value for the highlight. * - * @ingroup Efl_Ui_Win + * @ingroup Elm_Win_Group */ EAPI void elm_win_focus_highlight_enabled_set(Elm_Win *obj, Eina_Bool enabled); @@ -1353,7 +1353,7 @@ EAPI void elm_win_focus_highlight_enabled_set(Elm_Win *obj, Eina_Bool enabled); * * @return The enabled value for the highlight. * - * @ingroup Efl_Ui_Win + * @ingroup Elm_Win_Group */ EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Elm_Win *obj); @@ -1365,7 +1365,7 @@ EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Elm_Win *obj); * * @param[in] animate The enabled value for the highlight animation. * - * @ingroup Efl_Ui_Win + * @ingroup Elm_Win_Group */ EAPI void elm_win_focus_highlight_animate_set(Elm_Win *obj, Eina_Bool animate); @@ -1374,7 +1374,7 @@ EAPI void elm_win_focus_highlight_animate_set(Elm_Win *obj, Eina_Bool animate); * * @return The enabled value for the highlight animation. * - * @ingroup Efl_Ui_Win + * @ingroup Elm_Win_Group */ EAPI Eina_Bool elm_win_focus_highlight_animate_get(const Elm_Win *obj); -- 2.7.4