Document return value of event_waitTimeout()

[bertos.git] / bertos / mware / event.h

diff --git a/bertos/mware/event.h b/bertos/mware/event.h
index e6a8b1ee9debea065afbb70026e0db7bd92098bb..6f88676346f2e70c1af213529652443fff12fe7f 100644 (file)
--- a/bertos/mware/event.h
+++ b/bertos/mware/event.h
@@ -288,6 +288,8 @@ int event_select(Event **evs, int n, ticks_t timeout);
 /**
  * Wait the completion of event \a e or \a timeout elapses.
  *
+ * \return true if the event triggered, false if timed out
+ *
  * \note It's forbidden to use this function inside irq handling functions.
  */
 bool event_waitTimeout(Event *e, ticks_t timeout);