forked from enlightenment/efl
doxygen docs: Complete docs for Eina Module
And fix yet another doxygen grouping mess
This commit is contained in:
parent
2aae4a0c85
commit
78aa7a7467
|
@ -28,46 +28,33 @@
|
||||||
__attribute__((__used__)) __attribute__((unused, aligned(1))) = info;
|
__attribute__((__used__)) __attribute__((unused, aligned(1))) = info;
|
||||||
#define EINA_MODINFO(tag, info) _EINA_MODINFO(tag, 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.
|
* This macro is used for defining license.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
#define EINA_MODULE_LICENSE(_license) EINA_MODINFO(license, _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
|
* This macro is used for defining author
|
||||||
* Use "name <email>" or just "name"
|
* Use "name <email>" or just "name"
|
||||||
* for multiple authors, use multiple lines like below
|
* 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>");
|
"Author 2 <author2.email>");
|
||||||
|
@endcode
|
||||||
*/
|
*/
|
||||||
#define EINA_MODULE_AUTHOR(_author) EINA_MODINFO(author, _author)
|
#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.
|
* This macro is used for defining version.
|
||||||
*/
|
*/
|
||||||
#define EINA_MODULE_VERSION(_ver) EINA_MODINFO(ver, _ver)
|
#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.
|
* This macro is used for defining description.
|
||||||
* Explain what your module does.
|
* Explain what your module does.
|
||||||
|
|
|
@ -24,20 +24,10 @@
|
||||||
#include "eina_error.h"
|
#include "eina_error.h"
|
||||||
#include "eina_inline_modinfo.x"
|
#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
|
* @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
|
* Eina module provides some helpers over POSIX dlopen(). It is not
|
||||||
* meant to replace, abstract or make a "portable" version of
|
* meant to replace, abstract or make a "portable" version of
|
||||||
|
@ -59,6 +49,16 @@
|
||||||
* directory listing. See eina_module_arch_list_get(),
|
* directory listing. See eina_module_arch_list_get(),
|
||||||
* eina_module_list_get() and eina_module_find().
|
* 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_*/
|
#endif /*EINA_MODULE_H_*/
|
||||||
|
|
Loading…
Reference in New Issue