From 4ef5df302b6a0dc984ec503ec4f3cf6ed2be48d3 Mon Sep 17 00:00:00 2001 From: asterix Date: Wed, 11 Jan 2012 14:40:18 +0000 Subject: [PATCH] Document return value of event_waitTimeout() git-svn-id: https://src.develer.com/svnoss/bertos/trunk@5241 38d2e660-2303-0410-9eaa-f027e97ec537 --- bertos/mware/event.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/bertos/mware/event.h b/bertos/mware/event.h index e6a8b1ee..6f886763 100644 --- 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); -- 2.25.1