From 34e6fb82c6e54b11b49f80680d7364547f6159ca Mon Sep 17 00:00:00 2001 From: Xavi Artigas Date: Tue, 14 Apr 2020 17:58:13 +0200 Subject: [PATCH] doxygen docs: Fix missing docs in Edje --- src/lib/edje/Edje_Common.h | 3 +++ src/lib/edje/Edje_Legacy.h | 13 +++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/src/lib/edje/Edje_Common.h b/src/lib/edje/Edje_Common.h index 88405624ba..954c1e6770 100644 --- a/src/lib/edje/Edje_Common.h +++ b/src/lib/edje/Edje_Common.h @@ -808,6 +808,7 @@ struct _Edje_External_Param_Info #define EDJE_EXTERNAL_PARAM_INFO_SENTINEL {NULL, 0, 0, {.s = {NULL, NULL, NULL}}} +/** Version of the EDJE External ABI used by this library .*/ #define EDJE_EXTERNAL_TYPE_ABI_VERSION (3) /** @@ -860,6 +861,7 @@ struct _Edje_External_Type Edje_External_Param_Info *parameters_info; /**< An array of #Edje_External_Param_Info describing the different parameters this EXTERNAL may have. The last element in the array must be #EDJE_EXTERNAL_PARAM_INFO_SENTINEL. */ void *data; /**< Private user data that will be passed to all of the class functions. */ }; +/** Alias for _Edje_External_Type */ typedef struct _Edje_External_Type Edje_External_Type; /** @@ -873,6 +875,7 @@ struct _Edje_External_Type_Info const Edje_External_Type *info; /**< The type definition. */ }; +/** Alias for _Edje_External_Type_Info */ typedef struct _Edje_External_Type_Info Edje_External_Type_Info; /** diff --git a/src/lib/edje/Edje_Legacy.h b/src/lib/edje/Edje_Legacy.h index d91301ce92..24ef3f8b7f 100644 --- a/src/lib/edje/Edje_Legacy.h +++ b/src/lib/edje/Edje_Legacy.h @@ -1533,12 +1533,13 @@ EAPI double edje_object_base_scale_get(const Evas_Object *obj); * @{ */ +/** Directions in which a part can be dragged .*/ typedef enum _Edje_Drag_Dir { - EDJE_DRAG_DIR_NONE = 0, - EDJE_DRAG_DIR_X = 1, - EDJE_DRAG_DIR_Y = 2, - EDJE_DRAG_DIR_XY = 3 + EDJE_DRAG_DIR_NONE = 0, /**< Part cannot be dragged. */ + EDJE_DRAG_DIR_X = 1, /**< Part can be dragged in the horizontal direction. */ + EDJE_DRAG_DIR_Y = 2, /**< Part can be dragged in the vertical direction. */ + EDJE_DRAG_DIR_XY = 3 /**< Part can be dragged in every direction. */ } Edje_Drag_Dir; /** @@ -1628,8 +1629,8 @@ EAPI Eina_Bool edje_object_part_drag_size_get(const Evas_Object *obj, const char /** * @brief Determines dragable directions. * - * The dragable directions are defined in the EDC file, inside the @ref - * dragable section, by the attributes @c x and @c y. See the @ref edcref for + * The dragable directions are defined in the EDC file, inside the + * "dragable" section, by the attributes @c x and @c y. See the @ref edcref for * more information. * * @param[in] part The part name