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_link.h | |
| parent | 823df95bd73bf7195d9a9d3dacd418475c055bc8 (diff) | |
| download | edoors-9aee0986af098e355eec2c9d87ac4e3fc3fdcb42.zip edoors-9aee0986af098e355eec2c9d87ac4e3fc3fdcb42.tar.gz | |
documentation
Diffstat (limited to 'src/include/eiotas_link.h')
| -rw-r--r-- | src/include/eiotas_link.h | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/src/include/eiotas_link.h b/src/include/eiotas_link.h index 4cc4e44..2d10300 100644 --- a/src/include/eiotas_link.h +++ b/src/include/eiotas_link.h @@ -21,22 +21,34 @@ /** * @typedef Eiotas_Link - * Type for a Link between Eiotas_Iotas. + * Type for a Link between @ref Eiotas_Iota. */ typedef struct _Eiotas_Link Eiotas_Link; /** * @struct _Eiotas_Link - * Struct for a Link between Eiotas_Iotas. + * Struct for a Link between @ref Eiotas_Iota. */ struct _Eiotas_Link { }; /** + * @defgroup Eiotas_Link Eiotas_Link + * + * A Eiota_Link allows to apply a destination list to a @ref Eiotas_Particle with no defined destination. + * + * @{ + */ + +/** * @brief Free allocated resources. * - * @param link The Eiotas_Link to free. + * @param link The @ref Eiotas_Link to free. */ void eiotas_link_free(Eiotas_Link *link); +/** + * @} + */ + #endif // __EIOTAS_LINK_H__ |