From ce5ddc07440aeb1357c7133beac6959b90d21885 Mon Sep 17 00:00:00 2001 From: lottaviano Date: Mon, 14 Sep 2009 09:47:26 +0000 Subject: [PATCH] doc: Clarify timer documentation. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@2932 38d2e660-2303-0410-9eaa-f027e97ec537 --- bertos/drv/timer.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h index 40802b54..45b8103e 100644 --- a/bertos/drv/timer.h +++ b/bertos/drv/timer.h @@ -268,7 +268,16 @@ typedef struct Timer void timer_add(Timer *timer); Timer *timer_abort(Timer *timer); -/** Set the timer so that it calls an user hook when it expires */ +/** + * Set the timer so that it calls an user hook when it expires + * + * Sometimes you may want to use the same callback for different events, so you must have + * different data to operate on. The user_data parameter is such data. + * + * \param timer Timer struct to set the callback to + * \param func Function that will be called when the timer expires + * \param user_data Additional data you may want to pass to the callback + */ INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data) { event_initSoftint(&timer->expire, func, user_data); -- 2.25.1