diff --git a/src/lib/eet/Eet.h b/src/lib/eet/Eet.h index ef7832914c..455042fc0c 100644 --- a/src/lib/eet/Eet.h +++ b/src/lib/eet/Eet.h @@ -179,7 +179,6 @@ typedef struct _Eet_Version int revision; /** < svn revision (0 if a proper release or the svn revision number Eet is built from) */ } Eet_Version; -EAPI extern Eet_Version *eet_version; /** * @defgroup Eet_Group Top level functions @@ -189,6 +188,11 @@ EAPI extern Eet_Version *eet_version; * @{ */ +/** + * Eet Version Information + */ +EAPI extern Eet_Version *eet_version; + /** * @enum _Eet_Error * All the error identifiers known by Eet. @@ -4539,6 +4543,7 @@ eet_node_struct_child_new(const char *parent, Eet_Node *child); /** + * @ingroup Eet_Node_Group * @brief Gets a node's child nodes. * @param node The node * @return The first child node which contains a pointer to the @@ -4549,6 +4554,7 @@ EAPI Eet_Node * eet_node_children_get(Eet_Node *node); /** + * @ingroup Eet_Node_Group * @brief Gets the next node in a list of nodes. * @param node The node * @return A node which contains a pointer to the @@ -4559,6 +4565,7 @@ EAPI Eet_Node * eet_node_next_get(Eet_Node *node); /** + * @ingroup Eet_Node_Group * @brief Gets the parent node of a node. * @param node The node * @return The parent node of @p node @@ -4624,6 +4631,7 @@ eet_node_dump(Eet_Node *n, void *dumpdata); /** + * @ingroup Eet_Node_Group * @brief Returns the type of a node. * @param node The node * @return The node's type (EET_T_$TYPE) @@ -4633,6 +4641,7 @@ EAPI int eet_node_type_get(Eet_Node *node); /** + * @ingroup Eet_Node_Group * @brief Returns the node's data. * @param node The node * @return The data contained in the node @@ -4770,6 +4779,10 @@ struct _Eet_Node_Walk Eet_Node_Walk_Simple_Callback simple; }; +/** + * @ingroup Eet_Node_Group + * Walks trees of #Eet_Node + */ EAPI void * eet_node_walk(void *parent, const char *name, diff --git a/src/lib/eina/eina_bezier.h b/src/lib/eina/eina_bezier.h index bf309643fa..2c886fa681 100644 --- a/src/lib/eina/eina_bezier.h +++ b/src/lib/eina/eina_bezier.h @@ -19,6 +19,13 @@ #ifndef EINA_BEZIER_H #define EINA_BEZIER_H +/** + * @defgroup Eina_Bezier_Group Bezier Curve + * @ingroup Eina_Tools_Group + * + * @{ + */ + /** * Floating point cubic bezier curve */ @@ -182,4 +189,8 @@ EAPI void eina_bezier_bounds_get(const Eina_Bezier *b, double *x, double *y, dou */ EAPI void eina_bezier_on_interval(Eina_Bezier *b, double t0, double t1, Eina_Bezier *result); +/** + * @} + */ + #endif // EINA_BEZIER_H diff --git a/src/lib/eina/eina_quaternion.h b/src/lib/eina/eina_quaternion.h index 3de9996d05..aebf091983 100644 --- a/src/lib/eina/eina_quaternion.h +++ b/src/lib/eina/eina_quaternion.h @@ -18,6 +18,13 @@ #ifndef EINA_QUATERNION_H_ #define EINA_QUATERNION_H_ +/** + * @defgroup Eina_Quaternion_Group Quaternion + * @ingroup Eina_Containers_Group + * + * @{ + */ + typedef struct _Eina_Quaternion_F16p16 Eina_Quaternion_F16p16; typedef struct _Eina_Quaternion Eina_Quaternion; typedef struct _Eina_Point_3D Eina_Point_3D; @@ -266,4 +273,7 @@ EAPI void eina_quaternion_transform(Eina_Quaternion *out, const Eina_Quaternion */ EAPI double eina_quaternion_angle_plains(Eina_Quaternion *a, Eina_Quaternion *b); +/** + * @} + */ #endif diff --git a/src/lib/eio/Eio_Legacy.h b/src/lib/eio/Eio_Legacy.h index fbdd6fc3e3..b14c1177da 100644 --- a/src/lib/eio/Eio_Legacy.h +++ b/src/lib/eio/Eio_Legacy.h @@ -14,7 +14,11 @@ extern "C" { int revision; /**< Revision number */ } Eio_Version; - EAPI extern Eio_Version *eio_version; +/** + * Eio Version Information + * @ingroup Eio + */ +EAPI extern Eio_Version *eio_version; /** * @file diff --git a/src/lib/elementary/elm_mapbuf.h b/src/lib/elementary/elm_mapbuf.h index 9870211ef7..0506b164ea 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/evas/Evas.h b/src/lib/evas/Evas.h index c6699cd171..0bec46a0cf 100644 --- a/src/lib/evas/Evas.h +++ b/src/lib/evas/Evas.h @@ -135,13 +135,13 @@ type on Evas -- the rectangle. @li @ref Evas_Object_Polygon, to learn how to create polygon elements on the canvas. - @li @ref Evas_Line_Group, to learn how to create line elements on the + @li @ref Evas_Object_Line_Group, to learn how to create line elements on the canvas. @li @ref Evas_Object_Image, to learn about image objects, over which Evas can do a plethora of operations. - @li @ref Evas_Object_Text, to learn how to create textual elements on + @li @ref Evas_Object_Text_Group, to learn how to create textual elements on the canvas. - @li @ref Evas_Object_Textblock, to learn how to create multiline + @li @ref Evas_Object_Textblock_Group, to learn how to create multiline textual elements on the canvas. @li @ref Evas_Smart_Object_Group and @ref Evas_Smart_Group, to define diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h index 1b9572046e..97a5e1adb4 100644 --- a/src/lib/evas/Evas_Common.h +++ b/src/lib/evas/Evas_Common.h @@ -44,6 +44,11 @@ typedef struct _Evas_Version int revision; /**< git revision (0 if a proper release or the git revision number Evas is built from) */ } Evas_Version; +/** + * Evas Version Information + * @ingroup Evas_Main_Group + */ + EAPI extern Evas_Version * evas_version; /** @@ -1784,11 +1789,11 @@ EAPI Eina_Bool evas_object_image_extension_can_load_fast_get */ /** - * @defgroup Evas_Object_Text Text Object Functions + * @defgroup Evas_Object_Text_Group Text Object Functions * * Functions that operate on single line, single style text objects. * - * For multiline and multiple style text, see @ref Evas_Object_Textblock. + * For multiline and multiple style text, see @ref Evas_Object_Textblock_Group. * * See some @ref Example_Evas_Text "examples" on this group of functions. * @@ -1824,7 +1829,7 @@ EAPI Eina_Bool evas_object_image_extension_can_load_fast_get */ /** - * @defgroup Evas_Object_Textgrid Textgrid Object Functions + * @defgroup Evas_Object_Textgrid_Group Textgrid Object Functions * * Textgrid objects manage chunks of text as a 2D grid of cells, each of * which contains a single unicode character with color and style @@ -1868,7 +1873,7 @@ struct _Evas_Textgrid_Cell */ /** - * @defgroup Evas_Line_Group Line Object Functions + * @defgroup Evas_Object_Line_Group Line Object Functions * * Functions used to deal with evas line objects. * @@ -1907,7 +1912,7 @@ struct _Evas_Textgrid_Cell * Evas_Object_Group and the extensions defined in @ref * Evas_Smart_Object_Group. There are a couple of existent smart * objects in Evas itself (see @ref Evas_Object_Box, @ref - * Evas_Object_Table and @ref Evas_Smart_Object_Clipped). + * Evas_Object_Table_Group and @ref Evas_Smart_Object_Clipped). * * See also some @ref Example_Evas_Smart_Objects "examples" of this * group of functions. @@ -2889,7 +2894,7 @@ EAPI const Evas_Object_Box_Api *evas_object_box_smart_class_get(void) EINA_CONST */ /** - * @defgroup Evas_Object_Table Table Smart Object. + * @defgroup Evas_Object_Table_Group Table Smart Object. * * Convenience smart object that packs children using a tabular * layout using children size hints to define their size and @@ -2904,7 +2909,7 @@ EAPI const Evas_Object_Box_Api *evas_object_box_smart_class_get(void) EINA_CONST */ /** - * @defgroup Evas_Object_Grid Grid Smart Object. + * @defgroup Evas_Object_Grid_Group Grid Smart Object. * * Convenience smart object that packs children under a regular grid * layout, using their virtual grid location and size to determine diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index d86128c85d..59f38fefe4 100644 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -1556,6 +1556,10 @@ EAPI void evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a); */ EAPI void evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a); +/** + * @} + */ + /** * * Move the given Evas object to the given location inside its canvas' viewport. @@ -1775,7 +1779,7 @@ EAPI void evas_object_size_hint_weight_set(Evas_Object *obj, double x, double y) * Accepted values are zero or positive values. Some users might use this hint * as a boolean, but some might consider it as a proportion, see documentation * of possible users, which in Evas are the @ref Evas_Object_Box "box" and @ref - * Evas_Object_Table "table" smart objects. + * Evas_Object_Table_Group "table" smart objects. * * This is not a size enforcement in any way, it's just a hint that should be * used whenever appropriate. @@ -1803,7 +1807,7 @@ EAPI void evas_object_size_hint_weight_get(const Evas_Object *obj, double *x, do * up to the alignment space on the final scene composition. * * See documentation of possible users: in Evas, they are the @ref - * Evas_Object_Box "box" and @ref Evas_Object_Table "table" smart objects. + * Evas_Object_Box "box" and @ref Evas_Object_Table_Group "table" smart objects. * * For the horizontal component, 0.0 means to the left, 1.0 means to the right. * Analogously, for the vertical component, 0.0 to the top, 1.0 means to the @@ -2305,6 +2309,7 @@ EAPI Eina_Bool evas_object_pointer_coords_inside_get(const Evas_Object *eo_obj, * * The object may be an evas object, an elementary object or window, or an * evas 3D / VG object. + * @ingroup Evas_Object_Group */ EAPI Evas *evas_object_evas_get(const Eo *obj); @@ -2329,7 +2334,7 @@ EAPI Evas *evas_object_evas_get(const Eo *obj); * * @return The list of objects that are over the given position in @c e. * - * @ingroup Efl_Canvas + * @ingroup Evas_Canvas */ EAPI Eina_List *evas_objects_at_xy_get(Eo *eo_e, int x, int y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects); @@ -2356,6 +2361,7 @@ EAPI Evas *evas_object_evas_get(const Eo *obj); * * @return The Evas object that is over all other objects at the given * position. + * @ingroup Evas_Canvas */ EAPI Evas_Object* evas_object_top_at_xy_get(Eo *eo_e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects); @@ -2374,6 +2380,7 @@ EAPI Evas *evas_object_evas_get(const Eo *obj); * objects * * @return List of objects + * @ingroup Evas_Canvas */ EAPI Eina_List *evas_objects_in_rectangle_get(const Eo *obj, int x, int y, int w, int h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT; @@ -2407,9 +2414,6 @@ EAPI Eina_List *evas_objects_in_rectangle_get(const Eo *obj, int x, int y, int w * @ingroup Evas_Canvas */ EAPI Evas_Object *evas_object_top_in_rectangle_get(const Eo *obj, int x, int y, int w, int h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT; -/** - * @} - */ /** * @ingroup Evas_Object_Group_Events @@ -3534,10 +3538,10 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EIN */ /** - * @defgroup Evas_Object_Vg Vector Graphics Object + * @defgroup Evas_Object_Vg_Group Vector Graphics Object * @ingroup Evas * - * @ref Evas_Object_Vg is the scene graph for managing vector graphics objects. + * @ref Evas_Object_Vg_Group is the scene graph for managing vector graphics objects. * User can create shape objects as well as fill objects and give them to the * Evas_Object_Vg for drawing on the screen as well as managing the lifecycle * of the objects, enabling reuse of shape objects. @@ -6303,7 +6307,7 @@ EAPI void evas_object_image_alpha_mask_set(Evas_Object *obj, Eina_Bool ismask) E */ /** - * @addtogroup Evas_Object_Text + * @addtogroup Evas_Object_Text_Group * * @{ */ @@ -6316,7 +6320,7 @@ EAPI void evas_object_image_alpha_mask_set(Evas_Object *obj, Eina_Bool ismask) E * success. * * Text objects are for simple, single line text elements. If you want - * more elaborated text blocks, see @ref Evas_Object_Textblock. + * more elaborated text blocks, see @ref Evas_Object_Textblock_Group. * * @see evas_object_text_font_source_set() * @see evas_object_text_font_set() @@ -6450,7 +6454,7 @@ EAPI void evas_object_text_font_get(const Eo *obj, const char **font, Evas_Font_ #include "canvas/evas_textblock_legacy.h" /** - * @ingroup Evas_Object_Grid + * @ingroup Evas_Object_Grid_Group * * @{ */ @@ -6559,7 +6563,7 @@ EAPI void evas_object_textgrid_font_get(const Eo *obj, const char **font_name, E */ /** - * @ingroup Evas_Object_Line + * @addtogroup Evas_Object_Line_Group * * @{ */ @@ -7232,7 +7236,7 @@ EAPI Eina_List *evas_object_box_children_get(const Evas_Object * */ /** - * @addtogroup Evas_Object_Table + * @addtogroup Evas_Object_Table_Group * * @{ */ @@ -7279,7 +7283,7 @@ EAPI Eina_Bool evas_object_table_mirrored_get(const Eo *obj); */ /** - * @addtogroup Evas_Object_Grid + * @addtogroup Evas_Object_Grid_Group * * @{ */ @@ -8368,6 +8372,7 @@ EAPI void evas_object_map_enable_set(Evas_Object *obj, Eina_Bool enabled); * @return The value of @c enabled as passed to evas_object_map_enable_set(). * * @see evas_object_map_enable_set + * @ingroup Evas_Object_Group */ EAPI Eina_Bool evas_object_map_enable_get(const Evas_Object *obj); diff --git a/src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h b/src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h index d2d358cad5..cd8c2db026 100644 --- a/src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h +++ b/src/lib/evas/canvas/efl_canvas_vg_node_eo.legacy.h @@ -14,6 +14,11 @@ typedef Eo Evas_Vg_Node; #endif +/** + * @defgroup Evas_Vg_Node_Group + * @ingroup Evas_Object_Vg_Group + */ + /** * @brief Sets the transformation matrix to be used for this node object. * diff --git a/src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h b/src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h index da9de73795..4a693db7d9 100644 --- a/src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h +++ b/src/lib/evas/canvas/efl_canvas_vg_shape_eo.legacy.h @@ -13,6 +13,11 @@ typedef Eo Evas_Vg_Shape; #endif +/** + * @defgroup Evas_Vg_Shape_Group + * @ingroup Evas_Object_Vg_Group + */ + /** * @brief Fill of the shape object. * diff --git a/src/lib/evas/canvas/evas_table_eo.h b/src/lib/evas/canvas/evas_table_eo.h index 576e109320..c0c7b23000 100644 --- a/src/lib/evas/canvas/evas_table_eo.h +++ b/src/lib/evas/canvas/evas_table_eo.h @@ -17,7 +17,7 @@ typedef Eo Evas_Table; * See @ref evas_obj_table_homogeneous_get for an explanation of the function * of each one. * - * @ingroup Evas_Object_Table + * @ingroup Evas_Object_Table_Group */ typedef enum { diff --git a/src/lib/evas/canvas/evas_textblock_legacy.h b/src/lib/evas/canvas/evas_textblock_legacy.h index 13752081f4..cafc14499c 100644 --- a/src/lib/evas/canvas/evas_textblock_legacy.h +++ b/src/lib/evas/canvas/evas_textblock_legacy.h @@ -1,8 +1,8 @@ /** - * @defgroup Evas_Object_Textblock Textblock Object Functions + * @defgroup Evas_Object_Textblock_Group Textblock Object Functions * * Functions used to create and manipulate textblock objects. Unlike - * @ref Evas_Object_Text, these handle complex text, doing multiple + * @ref Evas_Object_Text_Group, these handle complex text, doing multiple * styles and multiline text based on HTML-like tags. Of these extra * features will be heavier on memory and processing cost. * @@ -656,7 +656,7 @@ EAPI Eina_Bool evas_textblock_cursor_word_end(Evas_Textblock_Cursor *obj); */ /** - * @addtogroup Evas_Object_Textblock + * @addtogroup Evas_Object_Textblock_Group * * @{ */