xartigas pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=78aa7a7467f55f8b72927f530df0c221126c90c3
commit 78aa7a7467f55f8b72927f530df0c221126c90c3 Author: Xavi Artigas <[email protected]> Date: Fri May 8 11:35:56 2020 +0200 doxygen docs: Complete docs for Eina Module And fix yet another doxygen grouping mess --- src/lib/eina/eina_inline_modinfo.x | 27 +++++++-------------------- src/lib/eina/eina_module.h | 28 ++++++++++++---------------- 2 files changed, 19 insertions(+), 36 deletions(-) diff --git a/src/lib/eina/eina_inline_modinfo.x b/src/lib/eina/eina_inline_modinfo.x index 582b7caf5a..a53de0a4a8 100644 --- a/src/lib/eina/eina_inline_modinfo.x +++ b/src/lib/eina/eina_inline_modinfo.x @@ -28,46 +28,33 @@ __attribute__((__used__)) __attribute__((unused, aligned(1))) = info; #define EINA_MODINFO(tag, info) _EINA_MODINFO(tag, info) -/** - * @defgroup Eina_Module_Group Module - * - * These macros allow you to define module informations like author/description/version/license. - * eina_modinfo - shows information about an eina module. - * eina_modinfo pulls out information from the eina modules given on command line. - * - * $ eina_modinfo module.so - * version: 0.1 - * description: Entry test - * license: GPLv2 - * author: Enlightenment Community - * - */ - /** - * @defgroup Eina_Module_Group Module + * @ingroup Eina_Module_Group * * This macro is used for defining license. * */ #define EINA_MODULE_LICENSE(_license) EINA_MODINFO(license, _license) /** - * @defgroup Eina_Module_Group Module + * @ingroup Eina_Module_Group * * This macro is used for defining author * Use "name <email>" or just "name" * for multiple authors, use multiple lines like below - * EINA_MODULE_AUTHOR("Author 1 <author1.email>\n + @code{.c} + EINA_MODULE_AUTHOR("Author 1 <author1.email>\n" "Author 2 <author2.email>"); + @endcode */ #define EINA_MODULE_AUTHOR(_author) EINA_MODINFO(author, _author) /** - * @defgroup Eina_Module_Group Module + * @ingroup Eina_Module_Group * * This macro is used for defining version. */ #define EINA_MODULE_VERSION(_ver) EINA_MODINFO(ver, _ver) /** - * @defgroup Eina_Module_Group Module + * @ingroup Eina_Module_Group * * This macro is used for defining description. * Explain what your module does. diff --git a/src/lib/eina/eina_module.h b/src/lib/eina/eina_module.h index 90400546a1..1fbd6153ac 100644 --- a/src/lib/eina/eina_module.h +++ b/src/lib/eina/eina_module.h @@ -24,20 +24,10 @@ #include "eina_error.h" #include "eina_inline_modinfo.x" -/** - * @addtogroup Eina_Module_Group Module - * - * @brief These functions provide module management. - */ - -/** - * @addtogroup Eina_Tools_Group Tools - * - * @{ - */ - /** * @defgroup Eina_Module_Group Module + * @ingroup Eina_Tools_Group Tools + * @brief These functions provide module management. * * Eina module provides some helpers over POSIX dlopen(). It is not * meant to replace, abstract or make a "portable" version of @@ -59,6 +49,16 @@ * directory listing. See eina_module_arch_list_get(), * eina_module_list_get() and eina_module_find(). * + * #EINA_MODULE_LICENSE, #EINA_MODULE_AUTHOR, #EINA_MODULE_VERSION and + * #EINA_MODULE_DESCRIPTION allow you to define module information that can + * be retrieved with the @c eina_modinfo tool. + @code{.sh} + $ eina_modinfo module.so + version: 0.1 + description: Entry test + license: GPLv2 + author: Enlightenment Community + @endcode * @{ */ @@ -340,8 +340,4 @@ EAPI Eina_Module * * @} */ -/** - * @} - */ - #endif /*EINA_MODULE_H_*/ --
