riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: xtimer: added missing documentation

Browse Source
This commit is contained in:
Oleg Hahm 2017-03-02 18:13:22 +01:00
parent d48330acbb
commit e420c7ad9e
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sys/include/xtimer.h
View File

@ -47,7 +47,7 @@ extern "C" {
* @note This is a struct in order to make the xtimer API type strict * @note This is a struct in order to make the xtimer API type strict
*/ */
typedef struct { typedef struct {
uint64_t ticks64; uint64_t ticks64; /**< Tick count */
} xtimer_ticks64_t; } xtimer_ticks64_t;
/** /**
@ -56,7 +56,7 @@ typedef struct {
* @note This is a struct in order to make the xtimer API type strict * @note This is a struct in order to make the xtimer API type strict
*/ */
typedef struct { typedef struct {
uint32_t ticks32; uint32_t ticks32; /**< Tick count */
} xtimer_ticks32_t; } xtimer_ticks32_t;
/** /**
@ -68,12 +68,12 @@ typedef void (*xtimer_callback_t)(void*);
* @brief xtimer timer structure * @brief xtimer timer structure
*/ */
typedef struct xtimer { typedef struct xtimer {
struct xtimer *next; /**< reference to next timer in timer lists */ struct xtimer *next; /**< reference to next timer in timer lists */
uint32_t target; /**< lower 32bit absolute target time */ uint32_t target; /**< lower 32bit absolute target time */
uint32_t long_target; /**< upper 32bit absolute target time */ uint32_t long_target; /**< upper 32bit absolute target time */
xtimer_callback_t callback; /**< callback function to call when timer xtimer_callback_t callback; /**< callback function to call when timer
expires */ expires */
void *arg; /**< argument to pass to callback function */ void *arg; /**< argument to pass to callback function */
} xtimer_t; } xtimer_t;
/** /**