diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-02-14 22:02:31 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-02-14 22:02:31 +0000 |
| commit | cae6f99028cca8d347dc5c2290b7f40a38b91753 (patch) | |
| tree | 13690f9914ea8b55349af7a3597e5889bf4e2794 | |
| parent | 1e0eee8bc4cda865471b0e9bd3caaf4c690ac068 (diff) | |
| download | ChibiOS-cae6f99028cca8d347dc5c2290b7f40a38b91753.tar.gz ChibiOS-cae6f99028cca8d347dc5c2290b7f40a38b91753.tar.bz2 ChibiOS-cae6f99028cca8d347dc5c2290b7f40a38b91753.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@772 35acf78f-673a-0410-8e92-d51de3d6d3f4
| -rw-r--r-- | src/chevents.c | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/src/chevents.c b/src/chevents.c index 01437079e..35f3505de 100644 --- a/src/chevents.c +++ b/src/chevents.c @@ -195,8 +195,9 @@ void chEvtDispatch(const evhandler_t handlers[], eventmask_t mask) { #if CH_OPTIMIZE_SPEED || !CH_USE_EVENTS_TIMEOUT || defined(__DOXYGEN__)
/**
- * @brief A pending event among those specified in @p ewmask is selected,
- * cleared and its mask returned.
+ * @brief Waits for exactly one of the specified events.
+ * @details The function waits for one event among those specified in
+ * @p ewmask to become pending then the event is cleared and returned.
*
* @param ewmask mask of the events that the function should wait for,
* @p ALL_EVENTS enables all the events
@@ -250,7 +251,7 @@ eventmask_t chEvtWaitAny(eventmask_t ewmask) { }
/**
- * @brief Waits for all the specified event flags then clears them.
+ * @brief Waits for all the specified events.
* @details The function waits for all the events specified in @p ewmask to
* become pending then the events are cleared and returned.
*
@@ -274,9 +275,9 @@ eventmask_t chEvtWaitAll(eventmask_t ewmask) { #if CH_USE_EVENTS_TIMEOUT
/**
- * @brief Waits for a single event.
- * @details A pending event among those specified in @p ewmask is selected,
- * cleared and its mask returned.
+ * @brief Waits for exactly one of the specified events.
+ * @details The function waits for one event among those specified in
+ * @p ewmask to become pending then the event is cleared and returned.
*
* @param ewmask mask of the events that the function should wait for,
* @p ALL_EVENTS enables all the events
@@ -309,8 +310,8 @@ eventmask_t chEvtWaitOneTimeout(eventmask_t ewmask, systime_t time) { /**
* @brief Waits for any of the specified events.
- * @details The function waits for any event among those specified in @p ewmask
- * to become pending then the events are cleared and returned.
+ * @details The function waits for any event among those specified in
+ * @p ewmask to become pending then the events are cleared and returned.
*
* @param ewmask mask of the events that the function should wait for,
* @p ALL_EVENTS enables all the events
@@ -336,7 +337,7 @@ eventmask_t chEvtWaitAnyTimeout(eventmask_t ewmask, systime_t time) { }
/**
- * @brief Waits for all the specified event flags then clears them.
+ * @brief Waits for all the specified events.
* @details The function waits for all the events specified in @p ewmask to
* become pending then the events are cleared and returned.
*
|