summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-04-14 16:11:04 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2020-04-14 18:48:30 +0200
commitf528001f0dc7c52f54fbabd08c2d4ad8909db768 (patch)
tree083a1f9d41b6f00365aaea475dbb0ef8506dfdfd
parentca0bb74321fcfc221cdb71ae849898a543cb1eda (diff)
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.
-rw-r--r--src/lib/ecore/Ecore_Common.h4
-rw-r--r--src/lib/ecore/Ecore_Eo.h8
-rw-r--r--src/lib/ecore/Ecore_Legacy.h16
-rw-r--r--src/lib/edje/Edje_Legacy.h24
-rw-r--r--src/lib/evas/Evas_Common.h4
-rw-r--r--src/lib/evas/Evas_Legacy.h30
-rw-r--r--src/lib/evas/canvas/evas_textblock_legacy.h5
7 files changed, 37 insertions, 54 deletions
diff --git a/src/lib/ecore/Ecore_Common.h b/src/lib/ecore/Ecore_Common.h
index 4ee0dd768b..899debc267 100644
--- a/src/lib/ecore/Ecore_Common.h
+++ b/src/lib/ecore/Ecore_Common.h
@@ -4,8 +4,8 @@
4#include <Efl_Config.h> 4#include <Efl_Config.h>
5 5
6/** 6/**
7 * @ingroup Ecore
8 * @defgroup Ecore_Init_Group Ecore initialization, shutdown functions and reset on fork. 7 * @defgroup Ecore_Init_Group Ecore initialization, shutdown functions and reset on fork.
8 * @ingroup Ecore
9 * @{ 9 * @{
10 */ 10 */
11 11
@@ -2660,8 +2660,8 @@ EAPI double ecore_throttle_get(void);
2660 */ 2660 */
2661 2661
2662/** 2662/**
2663 * @ingroup Ecore_Main_Loop_Group
2664 * @defgroup Ecore_Poller_Group Ecore Poll functions 2663 * @defgroup Ecore_Poller_Group Ecore Poll functions
2664 * @ingroup Ecore_Main_Loop_Group
2665 * 2665 *
2666 * Ecore poller provides infrastructure for the creation of pollers. Pollers 2666 * Ecore poller provides infrastructure for the creation of pollers. Pollers
2667 * are, in essence, callbacks that share a single timer per type. Because not 2667 * are, in essence, callbacks that share a single timer per type. Because not
diff --git a/src/lib/ecore/Ecore_Eo.h b/src/lib/ecore/Ecore_Eo.h
index 02b44f3482..d017ef9cb0 100644
--- a/src/lib/ecore/Ecore_Eo.h
+++ b/src/lib/ecore/Ecore_Eo.h
@@ -5,7 +5,7 @@
5#include <Eo.h> 5#include <Eo.h>
6 6
7/** 7/**
8 * @ingroup Ecore_Timer_Group 8 * @addtogroup Ecore_Timer_Group
9 * 9 *
10 * @{ 10 * @{
11 */ 11 */
@@ -21,7 +21,7 @@
21#include "efl_loop_message_future_handler.eo.h" 21#include "efl_loop_message_future_handler.eo.h"
22 22
23/** 23/**
24 * @ingroup Ecore_MainLoop_Group 24 * @addtogroup Ecore_MainLoop_Group
25 * 25 *
26 * @{ 26 * @{
27 */ 27 */
@@ -93,7 +93,7 @@ EAPI Eo *efl_main_loop_get(void);
93 */ 93 */
94 94
95/** 95/**
96 * @ingroup Ecore_Fd_Io_Group 96 * @addtogroup Ecore_Fd_Io_Group
97 * 97 *
98 * @{ 98 * @{
99 */ 99 */
@@ -115,7 +115,7 @@ EAPI Eo *efl_main_loop_get(void);
115 */ 115 */
116 116
117/** 117/**
118 * @ingroup Ecore_Model_Group 118 * @addtogroup Ecore_Model_Group
119 * 119 *
120 * @{ 120 * @{
121 */ 121 */
diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h
index d39ecb66f1..e4ed2773c1 100644
--- a/src/lib/ecore/Ecore_Legacy.h
+++ b/src/lib/ecore/Ecore_Legacy.h
@@ -2,7 +2,7 @@
2#define _ECORE_LEGACY_H 2#define _ECORE_LEGACY_H
3 3
4/** 4/**
5 * @ingroup Ecore_Poller_Group 5 * @addtogroup Ecore_Poller_Group
6 * 6 *
7 * @{ 7 * @{
8 */ 8 */
@@ -76,8 +76,6 @@ EAPI double ecore_poller_poll_interval_get(Ecore_Poller_Type type);
76 * @param[in] interval The tick interval; must be a power of 2 and <= 32768. 76 * @param[in] interval The tick interval; must be a power of 2 and <= 32768.
77 * 77 *
78 * @return @c true on success, @c false on failure. 78 * @return @c true on success, @c false on failure.
79 *
80 * @ingroup Ecore_Poller
81 */ 79 */
82EAPI Eina_Bool ecore_poller_poller_interval_set(Ecore_Poller *obj, int interval); 80EAPI Eina_Bool ecore_poller_poller_interval_set(Ecore_Poller *obj, int interval);
83 81
@@ -85,8 +83,6 @@ EAPI Eina_Bool ecore_poller_poller_interval_set(Ecore_Poller *obj, int interval)
85 * @brief Polling interval rate of the poller. 83 * @brief Polling interval rate of the poller.
86 * 84 *
87 * @return The tick interval; must be a power of 2 and <= 32768. 85 * @return The tick interval; must be a power of 2 and <= 32768.
88 *
89 * @ingroup Ecore_Poller
90 */ 86 */
91EAPI int ecore_poller_poller_interval_get(const Ecore_Poller *obj); 87EAPI int ecore_poller_poller_interval_get(const Ecore_Poller *obj);
92 88
@@ -95,7 +91,7 @@ EAPI int ecore_poller_poller_interval_get(const Ecore_Poller *obj);
95 */ 91 */
96 92
97/** 93/**
98 * @ingroup Ecore_Animator_Group 94 * @addtogroup Ecore_Animator_Group
99 * 95 *
100 * @{ 96 * @{
101 */ 97 */
@@ -209,7 +205,7 @@ EAPI void ecore_animator_thaw(Ecore_Animator *animator);
209 */ 205 */
210 206
211/** 207/**
212 * @ingroup Ecore_Timer_Group 208 * @addtogroup Ecore_Timer_Group
213 * 209 *
214 * @{ 210 * @{
215 */ 211 */
@@ -306,7 +302,7 @@ EAPI void ecore_timer_thaw(Ecore_Timer *timer);
306 */ 302 */
307 303
308/** 304/**
309 * @ingroup Ecore_Idle_Group 305 * @addtogroup Ecore_Idle_Group
310 * 306 *
311 * @{ 307 * @{
312 */ 308 */
@@ -391,7 +387,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
391 */ 387 */
392 388
393/** 389/**
394 * @ingroup Ecore_Exe_Group 390 * @addtogroup Ecore_Exe_Group
395 * 391 *
396 * @{ 392 * @{
397 */ 393 */
@@ -403,7 +399,7 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter);
403 */ 399 */
404 400
405/** 401/**
406 * @ingroup Ecore_Job_Group 402 * @addtogroup Ecore_Job_Group
407 * 403 *
408 * @{ 404 * @{
409 */ 405 */
diff --git a/src/lib/edje/Edje_Legacy.h b/src/lib/edje/Edje_Legacy.h
index 962e175160..d91301ce92 100644
--- a/src/lib/edje/Edje_Legacy.h
+++ b/src/lib/edje/Edje_Legacy.h
@@ -464,21 +464,21 @@ EAPI void edje_object_text_change_cb_set(Evas_Object *obj, Edje_Text_Change_Cb f
464 464
465 465
466/** 466/**
467 * @ingroup Edje_Object_Communication_Interface_Message 467 * @addtogroup Edje_Object_Communication_Interface_Message
468 * 468 *
469 * @{ 469 * @{
470 */ 470 */
471 471
472typedef struct _Edje_Message_String Edje_Message_String; 472typedef struct _Edje_Message_String Edje_Message_String; /**< Alias for _Edje_Message_String. */
473typedef struct _Edje_Message_Int Edje_Message_Int; 473typedef struct _Edje_Message_Int Edje_Message_Int; /**< Alias for _Edje_Message_Int */
474typedef struct _Edje_Message_Float Edje_Message_Float; 474typedef struct _Edje_Message_Float Edje_Message_Float; /**< Alias for _Edje_Message_Float */
475typedef struct _Edje_Message_String_Set Edje_Message_String_Set; 475typedef struct _Edje_Message_String_Set Edje_Message_String_Set; /**< Alias for _Edje_Message_String_Set */
476typedef struct _Edje_Message_Int_Set Edje_Message_Int_Set; 476typedef struct _Edje_Message_Int_Set Edje_Message_Int_Set; /**< Alias for _Edje_Message_Int_Set */
477typedef struct _Edje_Message_Float_Set Edje_Message_Float_Set; 477typedef struct _Edje_Message_Float_Set Edje_Message_Float_Set; /**< Alias for _Edje_Message_Float_Set */
478typedef struct _Edje_Message_String_Int Edje_Message_String_Int; 478typedef struct _Edje_Message_String_Int Edje_Message_String_Int; /**< Alias for _Edje_Message_String_Int */
479typedef struct _Edje_Message_String_Float Edje_Message_String_Float; 479typedef struct _Edje_Message_String_Float Edje_Message_String_Float; /**< Alias for _Edje_Message_String_Float */
480typedef struct _Edje_Message_String_Int_Set Edje_Message_String_Int_Set; 480typedef struct _Edje_Message_String_Int_Set Edje_Message_String_Int_Set; /**< Alias for _Edje_Message_String_Int_Set */
481typedef struct _Edje_Message_String_Float_Set Edje_Message_String_Float_Set; 481typedef struct _Edje_Message_String_Float_Set Edje_Message_String_Float_Set; /**< Alias for _Edje_Message_String_Float_Set */
482 482
483struct _Edje_Message_String 483struct _Edje_Message_String
484{ 484{
@@ -657,7 +657,7 @@ EAPI void edje_object_message_signal_recursive_process(Evas_Object *obj);
657 */ 657 */
658 658
659/** 659/**
660 * @ingroup Edje_Object 660 * @addgroup Edje_Object
661 * 661 *
662 * @{ 662 * @{
663 */ 663 */
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index c70b183a2a..d7add005fb 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -3311,7 +3311,7 @@ EAPI void evas_language_reinit(void);
3311 */ 3311 */
3312 3312
3313/** 3313/**
3314 * @ingroup Evas_Font_Group 3314 * @addtogroup Evas_Font_Group
3315 * 3315 *
3316 * @{ 3316 * @{
3317 */ 3317 */
@@ -3320,8 +3320,6 @@ EAPI void evas_language_reinit(void);
3320 * @defgroup Evas_Font_Path_Group Font Path Functions 3320 * @defgroup Evas_Font_Path_Group Font Path Functions
3321 * 3321 *
3322 * Functions that edit the paths being used to load fonts. 3322 * Functions that edit the paths being used to load fonts.
3323 *
3324 * @ingroup Evas_Font_Group
3325 */ 3323 */
3326 3324
3327/** 3325/**
diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h
index 4e483321a1..cc9a996edf 100644
--- a/src/lib/evas/Evas_Legacy.h
+++ b/src/lib/evas/Evas_Legacy.h
@@ -137,7 +137,7 @@ typedef unsigned long long Evas_Modifier_Mask;
137 137
138 138
139/** 139/**
140 * @ingroup Evas_Canvas_Events 140 * @addtogroup Evas_Canvas_Events
141 * 141 *
142 * @{ 142 * @{
143 */ 143 */
@@ -1168,7 +1168,7 @@ EAPI void evas_touch_point_list_nth_xy_get(Evas *eo_e, unsigned int n, Evas_Coor
1168 */ 1168 */
1169 1169
1170/** 1170/**
1171 * @ingroup Evas_Font_Group 1171 * @addtogroup Evas_Font_Group
1172 * 1172 *
1173 * @{ 1173 * @{
1174 */ 1174 */
@@ -1178,14 +1178,10 @@ EAPI void evas_touch_point_list_nth_xy_get(Evas *eo_e, unsigned int n, Evas_Coor
1178 * 1178 *
1179 * @param e The evas instance that returned such list. 1179 * @param e The evas instance that returned such list.
1180 * @param available the list returned by evas_font_dir_available_list(). 1180 * @param available the list returned by evas_font_dir_available_list().
1181 *
1182 * @ingroup Evas_Font_Group
1183 */ 1181 */
1184EAPI void evas_font_available_list_free(Evas *e, Eina_List *available) EINA_ARG_NONNULL(1); 1182EAPI void evas_font_available_list_free(Evas *e, Eina_List *available) EINA_ARG_NONNULL(1);
1185 1183
1186/** Flags for Font Hinting 1184/** Flags for Font Hinting
1187 *
1188 * @ingroup Evas_Font
1189 */ 1185 */
1190typedef enum 1186typedef enum
1191{ 1187{
@@ -1201,8 +1197,6 @@ typedef enum
1201 * 1197 *
1202 * @param[in] hinting The used hinting, one of #EVAS_FONT_HINTING_NONE, 1198 * @param[in] hinting The used hinting, one of #EVAS_FONT_HINTING_NONE,
1203 * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE. 1199 * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
1204 *
1205 * @ingroup Evas_Font_Group
1206 */ 1200 */
1207EAPI void evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting); 1201EAPI void evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting);
1208 1202
@@ -1211,8 +1205,6 @@ EAPI void evas_font_hinting_set(Evas *e, Evas_Font_Hinting_Flags hinting);
1211 * 1205 *
1212 * @return The used hinting, one of #EVAS_FONT_HINTING_NONE, 1206 * @return The used hinting, one of #EVAS_FONT_HINTING_NONE,
1213 * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE. 1207 * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
1214 *
1215 * @ingroup Evas_Font_Group
1216 */ 1208 */
1217EAPI Evas_Font_Hinting_Flags evas_font_hinting_get(const Evas *e); 1209EAPI Evas_Font_Hinting_Flags evas_font_hinting_get(const Evas *e);
1218 1210
@@ -6315,7 +6307,7 @@ EAPI void evas_object_image_alpha_mask_set(Evas_Object *obj, Eina_Bool ismask) E
6315 */ 6307 */
6316 6308
6317/** 6309/**
6318 * @ingroup Evas_Object_Text 6310 * @addtogroup Evas_Object_Text
6319 * 6311 *
6320 * @{ 6312 * @{
6321 */ 6313 */
@@ -6589,7 +6581,7 @@ EAPI Evas_Object *evas_object_line_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG
6589 */ 6581 */
6590 6582
6591/** 6583/**
6592 * @ingroup Evas_Object_Polygon 6584 * @addtogroup Evas_Object_Polygon
6593 * 6585 *
6594 * @{ 6586 * @{
6595 */ 6587 */
@@ -6603,15 +6595,13 @@ EAPI Evas_Object *evas_object_polygon_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_
6603/** 6595/**
6604 * @brief Adds the given point to the given evas polygon object. 6596 * @brief Adds the given point to the given evas polygon object.
6605 * 6597 *
6598 * @param[in] obj The object
6606 * @param[in] y The Y coordinate of the given point. 6599 * @param[in] y The Y coordinate of the given point.
6607 *
6608 * @ingroup Evas_Polygon
6609 */ 6600 */
6610EAPI void evas_object_polygon_point_add(Evas_Object *obj, Evas_Coord x, Evas_Coord y); 6601EAPI void evas_object_polygon_point_add(Evas_Object *obj, Evas_Coord x, Evas_Coord y);
6611 6602
6612/** Removes all of the points from the given evas polygon object. 6603/** Removes all of the points from the given evas polygon object.
6613 * 6604 * @param[in] obj The object
6614 * @ingroup Evas_Polygon
6615 */ 6605 */
6616EAPI void evas_object_polygon_points_clear(Evas_Object *obj); 6606EAPI void evas_object_polygon_points_clear(Evas_Object *obj);
6617 6607
@@ -6626,7 +6616,7 @@ EAPI void evas_object_polygon_points_clear(Evas_Object *obj);
6626 6616
6627 6617
6628/** 6618/**
6629 * @ingroup Evas_Smart_Object_Group 6619 * @addtogroup Evas_Smart_Object_Group
6630 * 6620 *
6631 * @{ 6621 * @{
6632 */ 6622 */
@@ -7101,7 +7091,7 @@ EAPI void evas_object_smart_move_children_relative(Evas_Object *obj, Evas_Coord
7101 */ 7091 */
7102 7092
7103/** 7093/**
7104 * @ingroup Evas_Object_Box 7094 * @addtogroup Evas_Object_Box
7105 * 7095 *
7106 * @{ 7096 * @{
7107 */ 7097 */
@@ -7237,7 +7227,7 @@ EAPI Eina_List *evas_object_box_children_get(const Evas_Object *
7237 */ 7227 */
7238 7228
7239/** 7229/**
7240 * @ingroup Evas_Object_Table 7230 * @addtogroup Evas_Object_Table
7241 * 7231 *
7242 * @{ 7232 * @{
7243 */ 7233 */
@@ -7284,7 +7274,7 @@ EAPI Eina_Bool evas_object_table_mirrored_get(const Eo *obj);
7284 */ 7274 */
7285 7275
7286/** 7276/**
7287 * @ingroup Evas_Object_Grid 7277 * @addtogroup Evas_Object_Grid
7288 * 7278 *
7289 * @{ 7279 * @{
7290 */ 7280 */
diff --git a/src/lib/evas/canvas/evas_textblock_legacy.h b/src/lib/evas/canvas/evas_textblock_legacy.h
index d52d78e15f..abcd794989 100644
--- a/src/lib/evas/canvas/evas_textblock_legacy.h
+++ b/src/lib/evas/canvas/evas_textblock_legacy.h
@@ -118,8 +118,7 @@
118 * @li password - "on" or "off". This is used to specifically turn replacing chars with the replacement char (i.e password mode) on and off. 118 * @li password - "on" or "off". This is used to specifically turn replacing chars with the replacement char (i.e password mode) on and off.
119 * 119 *
120 * @warning We don't guarantee any proper results if you create a Textblock 120 * @warning We don't guarantee any proper results if you create a Textblock
121 * object 121 * object without setting the evas engine.
122 * without setting the evas engine.
123 * 122 *
124 * @todo put here some usage examples 123 * @todo put here some usage examples
125 * 124 *
@@ -657,7 +656,7 @@ EAPI Eina_Bool evas_textblock_cursor_word_end(Evas_Textblock_Cursor *obj);
657 */ 656 */
658 657
659/** 658/**
660 * @ingroup Evas_Object_Textblock 659 * @addtogroup Evas_Object_Textblock
661 * 660 *
662 * @{ 661 * @{
663 */ 662 */