diff options
| author | Jérémy Zurcher <jeremy@asynk.ch> | 2012-05-29 17:09:40 +0200 |
|---|---|---|
| committer | Jérémy Zurcher <jeremy@asynk.ch> | 2012-05-29 17:09:40 +0200 |
| commit | 9aee0986af098e355eec2c9d87ac4e3fc3fdcb42 (patch) | |
| tree | 09f0165226b2f8711a4730abfdf2e7c4d35ce474 /src/include/eiotas_main.h | |
| parent | 823df95bd73bf7195d9a9d3dacd418475c055bc8 (diff) | |
| download | edoors-9aee0986af098e355eec2c9d87ac4e3fc3fdcb42.zip edoors-9aee0986af098e355eec2c9d87ac4e3fc3fdcb42.tar.gz | |
documentation
Diffstat (limited to 'src/include/eiotas_main.h')
| -rw-r--r-- | src/include/eiotas_main.h | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/src/include/eiotas_main.h b/src/include/eiotas_main.h index d75ab96..75ac6fe 100644 --- a/src/include/eiotas_main.h +++ b/src/include/eiotas_main.h @@ -23,20 +23,32 @@ /** * @typedef Eiotas_Version - * The version of Eiotas. + * Type for the version of Eiotas. */ -typedef struct _Eiotas_Version +typedef struct _Eiotas_Version Eiotas_Version; + +/** + * @struct _Eiotas_Version + * Struct version of Eiotas. + */ +struct _Eiotas_Version { int major; /**< Major component of the version */ int minor; /**< Minor component of the version */ int micro; /**< Micro component of the version */ -} Eiotas_Version; +}; EAPI extern Eiotas_Version *eiotas_version; EAPI extern int _eiotas_log_dom; /** + * @defgroup Eiotas_Main Eiotas + * + * @{ + */ + +/** * @brief Initialize the Eiotas library. * * @return 1 or greater on success, 0 on error. @@ -67,4 +79,8 @@ EAPI int eiotas_init(); */ EAPI int eiotas_shutdown(); +/** + * @} + */ + #endif // __EIOTAS_MAIN_H__ |