diff options
Diffstat (limited to 'src/lib/evtimer.c')
| -rw-r--r-- | src/lib/evtimer.c | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/src/lib/evtimer.c b/src/lib/evtimer.c index 786a25c7f..691484336 100644 --- a/src/lib/evtimer.c +++ b/src/lib/evtimer.c @@ -18,11 +18,8 @@ */
/**
- * @file evtimer.c
+ * @addtogroup event_timer
* @{
- * Event Timer, this timer generates an event at regular intervals. The
- * listening threads can use the event to perform time related activities.
- * Multiple threads can listen to the same timer.
*/
#include <ch.h>
@@ -37,8 +34,9 @@ static void tmrcb(void *p) { }
/**
- * Starts the timer, if the timer was already running then the function has
- * no effect.
+ * @brief Starts the timer
+ * @details If the timer was already running then the function has no effect.
+ *
* @param etp pointer to an initialized @p EvTimer structure.
*/
void evtStart(EvTimer *etp) {
@@ -52,8 +50,9 @@ void evtStart(EvTimer *etp) { }
/**
- * Stops the timer, if the timer was already stopped then the function has
- * no effect.
+ * @brief Stops the timer.
+ * @details If the timer was already stopped then the function has no effect.
+ *
* @param etp pointer to an initialized @p EvTimer structure.
*/
void evtStop(EvTimer *etp) {
|