diff options
author | Xavi Artigas <xavierartigas@yahoo.es> | 2020-04-14 16:11:04 +0200 |
---|---|---|
committer | Xavi Artigas <xavierartigas@yahoo.es> | 2020-04-14 18:48:30 +0200 |
commit | f528001f0dc7c52f54fbabd08c2d4ad8909db768 (patch) | |
tree | 083a1f9d41b6f00365aaea475dbb0ef8506dfdfd /src/lib/edje | |
parent | ca0bb74321fcfc221cdb71ae849898a543cb1eda (diff) | |
download | efl-f528001f0dc7c52f54fbabd08c2d4ad8909db768.tar.gz |
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.
Diffstat (limited to 'src/lib/edje')
-rw-r--r-- | src/lib/edje/Edje_Legacy.h | 24 |
1 files changed, 12 insertions, 12 deletions
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 /** - * @ingroup Edje_Object_Communication_Interface_Message + * @addtogroup Edje_Object_Communication_Interface_Message * * @{ */ -typedef struct _Edje_Message_String Edje_Message_String; -typedef struct _Edje_Message_Int Edje_Message_Int; -typedef struct _Edje_Message_Float Edje_Message_Float; -typedef struct _Edje_Message_String_Set Edje_Message_String_Set; -typedef struct _Edje_Message_Int_Set Edje_Message_Int_Set; -typedef struct _Edje_Message_Float_Set Edje_Message_Float_Set; -typedef struct _Edje_Message_String_Int Edje_Message_String_Int; -typedef struct _Edje_Message_String_Float Edje_Message_String_Float; -typedef struct _Edje_Message_String_Int_Set Edje_Message_String_Int_Set; -typedef struct _Edje_Message_String_Float_Set Edje_Message_String_Float_Set; +typedef struct _Edje_Message_String Edje_Message_String; /**< Alias for _Edje_Message_String. */ +typedef struct _Edje_Message_Int Edje_Message_Int; /**< Alias for _Edje_Message_Int */ +typedef struct _Edje_Message_Float Edje_Message_Float; /**< Alias for _Edje_Message_Float */ +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; /**< Alias for _Edje_Message_Int_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; /**< Alias for _Edje_Message_String_Int */ +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; /**< Alias for _Edje_Message_String_Int_Set */ +typedef struct _Edje_Message_String_Float_Set Edje_Message_String_Float_Set; /**< Alias for _Edje_Message_String_Float_Set */ 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 * * @{ */ |