enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 6 Projects Releases Wiki Activity

doxygen docs: Proper usage of @ingroup and @addtogroup 

This patch brings in a lot of docs which were missing before.
Unfortunately, this brings along their warnings so this ends up adding
more warnings than it fixes. Still, a step in the right direction.

@ingroup puts the current block into the specified group, but IT DOES NOT
allow opening groups with @{.
This was used in lots of places, resulting in misplaced or ignored documentation.
@ingroup should be used only in individual docs. For groups we use @defgroup and
@addtogroup.

Also,this patch adds some small missing docs.
This commit is contained in:
Xavi Artigas 2020-04-14 16:11:04 +02:00
parent ca0bb74321
commit f528001f0d
7 changed files with 37 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/lib/ecore/Ecore_Common.h
View File

@ -4,8 +4,8 @@
#include <Efl_Config.h> #include <Efl_Config.h>
/** /**
* @ingroup Ecore
* @defgroup Ecore_Init_Group Ecore initialization, shutdown functions and reset on fork. * @defgroup Ecore_Init_Group Ecore initialization, shutdown functions and reset on fork.
* @ingroup Ecore
* @{ * @{
*/ */
@ -2660,8 +2660,8 @@ EAPI double ecore_throttle_get(void);
*/ */
/** /**
* @ingroup Ecore_Main_Loop_Group
* @defgroup Ecore_Poller_Group Ecore Poll functions * @defgroup Ecore_Poller_Group Ecore Poll functions
* @ingroup Ecore_Main_Loop_Group
* *
* Ecore poller provides infrastructure for the creation of pollers. Pollers * Ecore poller provides infrastructure for the creation of pollers. Pollers
* are, in essence, callbacks that share a single timer per type. Because not * are, in essence, callbacks that share a single timer per type. Because not

8
src/lib/ecore/Ecore_Eo.h
View File

@ -5,7 +5,7 @@
#include <Eo.h> #include <Eo.h>
/** /**
* @ingroup Ecore_Timer_Group * @addtogroup Ecore_Timer_Group
* *
* @{ * @{
*/ */
@ -21,7 +21,7 @@
#include "efl_loop_message_future_handler.eo.h" #include "efl_loop_message_future_handler.eo.h"
/** /**
* @ingroup Ecore_MainLoop_Group * @addtogroup Ecore_MainLoop_Group
* *
* @{ * @{
*/ */
@ -93,7 +93,7 @@ EAPI Eo *efl_main_loop_get(void);
*/ */
/** /**
* @ingroup Ecore_Fd_Io_Group * @addtogroup Ecore_Fd_Io_Group
* *
* @{ * @{
*/ */
@ -115,7 +115,7 @@ EAPI Eo *efl_main_loop_get(void);
*/ */
/** /**
* @ingroup Ecore_Model_Group * @addtogroup Ecore_Model_Group
* *
* @{ * @{
*/ */

16
src/lib/ecore/Ecore_Legacy.h
View File

@ -2,7 +2,7 @@
#define _ECORE_LEGACY_H #define _ECORE_LEGACY_H
/** /**
* @ingroup Ecore_Poller_Group * @addtogroup Ecore_Poller_Group
* *
* @{ * @{
*/ */
@ -76,8 +76,6 @@ EAPI double ecore_poller_poll_interval_get(Ecore_Poller_Type type);
* @param[in] interval The tick interval; must be a power of 2 and <= 32768. * @param[in] interval The tick interval; must be a power of 2 and <= 32768.
* *
* @return @c true on success, @c false on failure. * @return @c true on success, @c false on failure.
*
* @ingroup Ecore_Poller
*/ */
EAPI Eina_Bool ecore_poller_poller_interval_set(Ecore_Poller *obj, int interval); EAPI Eina_Bool ecore_poller_poller_interval_set(Ecore_Poller *obj, int interval);
@ -85,8 +83,6 @@ EAPI Eina_Bool ecore_poller_poller_interval_set(Ecore_Poller *obj, int interval)
* @brief Polling interval rate of the poller. * @brief Polling interval rate of the poller.
* *
* @return The tick interval; must be a power of 2 and <= 32768. * @return The tick interval; must be a power of 2 and <= 32768.
*
* @ingroup Ecore_Poller
*/ */
EAPI int ecore_poller_poller_interval_get(const Ecore_Poller *obj); EAPI int ecore_poller_poller_interval_get(const Ecore_Poller *obj);
@ -95,7 +91,7 @@ EAPI int ecore_poller_poller_interval_get(const Ecore_Poller *obj);
*/ */
/** /**
* @ingroup Ecore_Animator_Group * @addtogroup Ecore_Animator_Group
* *
* @{ * @{
*/ */
@ -209,7 +205,7 @@ EAPI void ecore_animator_thaw(Ecore_Animator *animator);
*/ */
/** /**
* @ingroup Ecore_Timer_Group * @addtogroup Ecore_Timer_Group
* *
* @{ * @{
*/ */
@ -306,7 +302,7 @@ EAPI void ecore_timer_thaw(Ecore_Timer *timer);
*/ */
/** /**
* @ingroup Ecore_Idle_Group * @addtogroup Ecore_Idle_Group
* *
* @{ * @{
*/ */
@ -391,7 +387,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
*/ */
/** /**
* @ingroup Ecore_Exe_Group * @addtogroup Ecore_Exe_Group
* *
* @{ * @{
*/ */
@ -403,7 +399,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
*/ */
/** /**
* @ingroup Ecore_Job_Group * @addtogroup Ecore_Job_Group
* *
* @{ * @{
*/ */

24
src/lib/edje/Edje_Legacy.h
View File

@ -464,21 +464,21 @@ EAPI void edje_object_text_change_cb_set(Evas_Object *obj, Edje_Text_Change_Cb f
/** /**
* @ingroup Edje_Object_Communication_Interface_Message * @addtogroup Edje_Object_Communication_Interface_Message
* *
* @{ * @{
*/ */
typedef struct _Edje_Message_String Edje_Message_String; typedef struct _Edje_Message_String Edje_Message_String; /**< Alias for _Edje_Message_String. */
typedef struct _Edje_Message_Int Edje_Message_Int; typedef struct _Edje_Message_Int Edje_Message_Int; /**< Alias for _Edje_Message_Int */
typedef struct _Edje_Message_Float Edje_Message_Float; typedef struct _Edje_Message_Float Edje_Message_Float; /**< Alias for _Edje_Message_Float */
typedef struct _Edje_Message_String_Set Edje_Message_String_Set; typedef struct _Edje_Message_String_Set Edje_Message_String_Set; /**< Alias for _Edje_Message_String_Set */
typedef struct _Edje_Message_Int_Set Edje_Message_Int_Set; typedef struct _Edje_Message_Int_Set Edje_Message_Int_Set; /**< Alias for _Edje_Message_Int_Set */
typedef struct _Edje_Message_Float_Set Edje_Message_Float_Set; typedef struct _Edje_Message_Float_Set Edje_Message_Float_Set; /**< Alias for _Edje_Message_Float_Set */
typedef struct _Edje_Message_String_Int Edje_Message_String_Int; typedef struct _Edje_Message_String_Int Edje_Message_String_Int; /**< Alias for _Edje_Message_String_Int */
typedef struct _Edje_Message_String_Float Edje_Message_String_Float; typedef struct _Edje_Message_String_Float Edje_Message_String_Float; /**< Alias for _Edje_Message_String_Float */
typedef struct _Edje_Message_String_Int_Set Edje_Message_String_Int_Set; typedef struct _Edje_Message_String_Int_Set Edje_Message_String_Int_Set; /**< Alias for _Edje_Message_String_Int_Set */
typedef struct _Edje_Message_String_Float_Set Edje_Message_String_Float_Set; typedef struct _Edje_Message_String_Float_Set Edje_Message_String_Float_Set; /**< Alias for _Edje_Message_String_Float_Set */
struct _Edje_Message_String struct _Edje_Message_String
{ {
@ -657,7 +657,7 @@ EAPI void edje_object_message_signal_recursive_process(Evas_Object *obj);
*/ */
/** /**
* @ingroup Edje_Object * @addgroup Edje_Object
* *
* @{ * @{
*/ */

4
src/lib/evas/Evas_Common.h
View File

@ -3311,7 +3311,7 @@ EAPI void evas_language_reinit(void);
*/ */
/** /**
* @ingroup Evas_Font_Group * @addtogroup Evas_Font_Group
* *
* @{ * @{
*/ */
@ -3320,8 +3320,6 @@ EAPI void evas_language_reinit(void);
* @defgroup Evas_Font_Path_Group Font Path Functions * @defgroup Evas_Font_Path_Group Font Path Functions
* *
* Functions that edit the paths being used to load fonts. * Functions that edit the paths being used to load fonts.
*
* @ingroup Evas_Font_Group
*/ */
/** /**

30
src/lib/evas/Evas_Legacy.h
View File

@ -137,7 +137,7 @@ typedef unsigned long long Evas_Modifier_Mask;
/** /**
* @ingroup Evas_Canvas_Events * @addtogroup Evas_Canvas_Events
* *
* @{ * @{
*/ */
@ -1168,7 +1168,7 @@ EAPI void evas_touch_point_list_nth_xy_get(Evas *eo_e, unsigned int n, Evas_Coor
*/ */
/** /**
* @ingroup Evas_Font_Group * @addtogroup Evas_Font_Group
* *
* @{ * @{
*/ */
@ -1178,14 +1178,10 @@ EAPI void evas_touch_point_list_nth_xy_get(Evas *eo_e, unsigned int n, Evas_Coor
* *
* @param e The evas instance that returned such list. * @param e The evas instance that returned such list.
* @param available the list returned by evas_font_dir_available_list(). * @param available the list returned by evas_font_dir_available_list().
*
* @ingroup Evas_Font_Group
*/ */
EAPI void evas_font_available_list_free(Evas *e, Eina_List *available) EINA_ARG_NONNULL(1); EAPI void evas_font_available_list_free(Evas *e, Eina_List *available) EINA_ARG_NONNULL(1);
/** Flags for Font Hinting /** Flags for Font Hinting
*
* @ingroup Evas_Font
*/ */
typedef enum typedef enum
{ {
@ -1201,8 +1197,6 @@ typedef enum
* *
* @param[in] hinting The used hinting, one of #EVAS_FONT_HINTING_NONE, * @param[in] hinting The used hinting, one of #EVAS_FONT_HINTING_NONE,
* #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE. * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
*
* @ingroup Evas_Font_Group
*/ */
EAPI void evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting); EAPI void evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting);
@ -1211,8 +1205,6 @@ EAPI void evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting);
* *
* @return The used hinting, one of #EVAS_FONT_HINTING_NONE, * @return The used hinting, one of #EVAS_FONT_HINTING_NONE,
* #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE. * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
*
* @ingroup Evas_Font_Group
*/ */
EAPI Evas_Font_Hinting_Flags evas_font_hinting_get(const Evas *e); EAPI Evas_Font_Hinting_Flags evas_font_hinting_get(const Evas *e);
@ -6315,7 +6307,7 @@ EAPI void evas_object_image_alpha_mask_set(Evas_Object *obj, Eina_Bool ismask) E
*/ */
/** /**
* @ingroup Evas_Object_Text * @addtogroup Evas_Object_Text
* *
* @{ * @{
*/ */
@ -6589,7 +6581,7 @@ EAPI Evas_Object *evas_object_line_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG
*/ */
/** /**
* @ingroup Evas_Object_Polygon * @addtogroup Evas_Object_Polygon
* *
* @{ * @{
*/ */
@ -6603,15 +6595,13 @@ EAPI Evas_Object *evas_object_polygon_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_
/** /**
* @brief Adds the given point to the given evas polygon object. * @brief Adds the given point to the given evas polygon object.
* *
* @param[in] obj The object
* @param[in] y The Y coordinate of the given point. * @param[in] y The Y coordinate of the given point.
*
* @ingroup Evas_Polygon
*/ */
EAPI void evas_object_polygon_point_add(Evas_Object *obj, Evas_Coord x, Evas_Coord y); EAPI void evas_object_polygon_point_add(Evas_Object *obj, Evas_Coord x, Evas_Coord y);
/** Removes all of the points from the given evas polygon object. /** Removes all of the points from the given evas polygon object.
* * @param[in] obj The object
* @ingroup Evas_Polygon
*/ */
EAPI void evas_object_polygon_points_clear(Evas_Object *obj); EAPI void evas_object_polygon_points_clear(Evas_Object *obj);
@ -6626,7 +6616,7 @@ EAPI void evas_object_polygon_points_clear(Evas_Object *obj);
/** /**
* @ingroup Evas_Smart_Object_Group * @addtogroup Evas_Smart_Object_Group
* *
* @{ * @{
*/ */
@ -7101,7 +7091,7 @@ EAPI void evas_object_smart_move_children_relative(Evas_Object *obj, Evas_Coord
*/ */
/** /**
* @ingroup Evas_Object_Box * @addtogroup Evas_Object_Box
* *
* @{ * @{
*/ */
@ -7237,7 +7227,7 @@ EAPI Eina_List *evas_object_box_children_get(const Evas_Object *
*/ */
/** /**
* @ingroup Evas_Object_Table * @addtogroup Evas_Object_Table
* *
* @{ * @{
*/ */
@ -7284,7 +7274,7 @@ EAPI Eina_Bool evas_object_table_mirrored_get(const Eo *obj);
*/ */
/** /**
* @ingroup Evas_Object_Grid * @addtogroup Evas_Object_Grid
* *
* @{ * @{
*/ */

5
src/lib/evas/canvas/evas_textblock_legacy.h
View File

@ -118,8 +118,7 @@
* @li password - "on" or "off". This is used to specifically turn replacing chars with the replacement char (i.e password mode) on and off. * @li password - "on" or "off". This is used to specifically turn replacing chars with the replacement char (i.e password mode) on and off.
* *
* @warning We don't guarantee any proper results if you create a Textblock * @warning We don't guarantee any proper results if you create a Textblock
* object * object without setting the evas engine.
* without setting the evas engine.
* *
* @todo put here some usage examples * @todo put here some usage examples
* *
@ -657,7 +656,7 @@ EAPI Eina_Bool evas_textblock_cursor_word_end(Evas_Textblock_Cursor *obj);
*/ */
/** /**
* @ingroup Evas_Object_Textblock * @addtogroup Evas_Object_Textblock
* *
* @{ * @{
*/ */