X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fdrv%2Ftimer.h;h=45b8103eff137c1d3f7c07a01eac22975c2f9750;hb=dc6a4666ebeba9a0b485d130d031b2fa822160ad;hp=40802b543cb9f981f909e6c731fc1e17a8e499b9;hpb=8baedd5c716fca8f63e9c9b2e64071f12c29dc9d;p=bertos.git

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);