summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-05-08 11:35:56 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2020-05-08 12:32:09 +0200
commit78aa7a7467f55f8b72927f530df0c221126c90c3 (patch)
treead4b42a95d9cb4303b42b47e8aa951c3561a53ab
parent2aae4a0c859eaec8af46d3d6898e577b0d667f99 (diff)
doxygen docs: Complete docs for Eina Module
And fix yet another doxygen grouping mess
-rw-r--r--src/lib/eina/eina_inline_modinfo.x27
-rw-r--r--src/lib/eina/eina_module.h28
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 @@
28__attribute__((__used__)) __attribute__((unused, aligned(1))) = info; 28__attribute__((__used__)) __attribute__((unused, aligned(1))) = info;
29#define EINA_MODINFO(tag, info) _EINA_MODINFO(tag, info) 29#define EINA_MODINFO(tag, info) _EINA_MODINFO(tag, info)
30 30
31/**
32 * @defgroup Eina_Module_Group Module
33 *
34 * These macros allow you to define module informations like author/description/version/license.
35 * eina_modinfo - shows information about an eina module.
36 * eina_modinfo pulls out information from the eina modules given on command line.
37 *
38 * $ eina_modinfo module.so
39 * version: 0.1
40 * description: Entry test
41 * license: GPLv2
42 * author: Enlightenment Community
43 *
44 */
45
46/** 31/**
47 * @defgroup Eina_Module_Group Module 32 * @ingroup Eina_Module_Group
48 * 33 *
49 * This macro is used for defining license. 34 * This macro is used for defining license.
50 * 35 *
51 */ 36 */
52#define EINA_MODULE_LICENSE(_license) EINA_MODINFO(license, _license) 37#define EINA_MODULE_LICENSE(_license) EINA_MODINFO(license, _license)
53/** 38/**
54 * @defgroup Eina_Module_Group Module 39 * @ingroup Eina_Module_Group
55 * 40 *
56 * This macro is used for defining author 41 * This macro is used for defining author
57 * Use "name <email>" or just "name" 42 * Use "name <email>" or just "name"
58 * for multiple authors, use multiple lines like below 43 * for multiple authors, use multiple lines like below
59 * EINA_MODULE_AUTHOR("Author 1 <author1.email>\n 44 @code{.c}
45 EINA_MODULE_AUTHOR("Author 1 <author1.email>\n"
60 "Author 2 <author2.email>"); 46 "Author 2 <author2.email>");
47 @endcode
61 */ 48 */
62#define EINA_MODULE_AUTHOR(_author) EINA_MODINFO(author, _author) 49#define EINA_MODULE_AUTHOR(_author) EINA_MODINFO(author, _author)
63/** 50/**
64 * @defgroup Eina_Module_Group Module 51 * @ingroup Eina_Module_Group
65 * 52 *
66 * This macro is used for defining version. 53 * This macro is used for defining version.
67 */ 54 */
68#define EINA_MODULE_VERSION(_ver) EINA_MODINFO(ver, _ver) 55#define EINA_MODULE_VERSION(_ver) EINA_MODINFO(ver, _ver)
69/** 56/**
70 * @defgroup Eina_Module_Group Module 57 * @ingroup Eina_Module_Group
71 * 58 *
72 * This macro is used for defining description. 59 * This macro is used for defining description.
73 * Explain what your module does. 60 * 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
@@ -25,19 +25,9 @@
25#include "eina_inline_modinfo.x" 25#include "eina_inline_modinfo.x"
26 26
27/** 27/**
28 * @addtogroup Eina_Module_Group Module
29 *
30 * @brief These functions provide module management.
31 */
32
33/**
34 * @addtogroup Eina_Tools_Group Tools
35 *
36 * @{
37 */
38
39/**
40 * @defgroup Eina_Module_Group Module 28 * @defgroup Eina_Module_Group Module
29 * @ingroup Eina_Tools_Group Tools
30 * @brief These functions provide module management.
41 * 31 *
42 * Eina module provides some helpers over POSIX dlopen(). It is not 32 * Eina module provides some helpers over POSIX dlopen(). It is not
43 * meant to replace, abstract or make a "portable" version of 33 * meant to replace, abstract or make a "portable" version of
@@ -59,6 +49,16 @@
59 * directory listing. See eina_module_arch_list_get(), 49 * directory listing. See eina_module_arch_list_get(),
60 * eina_module_list_get() and eina_module_find(). 50 * eina_module_list_get() and eina_module_find().
61 * 51 *
52 * #EINA_MODULE_LICENSE, #EINA_MODULE_AUTHOR, #EINA_MODULE_VERSION and
53 * #EINA_MODULE_DESCRIPTION allow you to define module information that can
54 * be retrieved with the @c eina_modinfo tool.
55 @code{.sh}
56 $ eina_modinfo module.so
57 version: 0.1
58 description: Entry test
59 license: GPLv2
60 author: Enlightenment Community
61 @endcode
62 * @{ 62 * @{
63 */ 63 */
64 64
@@ -340,8 +340,4 @@ EAPI Eina_Module *
340 * @} 340 * @}
341 */ 341 */
342 342
343/**
344 * @}
345 */
346
347#endif /*EINA_MODULE_H_*/ 343#endif /*EINA_MODULE_H_*/