• R/O
  • SSH
  • HTTPS

chibios: Commit


Commit MetaInfo

Revision13094 (tree)
Time2019-10-08 00:21:57
Authorgdisirio

Log Message

Documentation fixes.

Change Summary

Incremental Difference

--- trunk/os/rt/src/chevents.c (revision 13093)
+++ trunk/os/rt/src/chevents.c (revision 13094)
@@ -31,12 +31,12 @@
3131 * @p thread_t structure.
3232 * Operations defined for events:
3333 * - <b>Wait</b>, the invoking thread goes to sleep until a certain
34- * AND/OR combination of events become pending.
34+ * AND/OR combination of events are signaled.
3535 * - <b>Clear</b>, a mask of events is cleared from the pending
3636 * events, the cleared events mask is returned (only the
3737 * events that were actually pending and then cleared).
38- * - <b>Signal</b>, an events mask is directly ORed to the mask of the
39- * signaled thread.
38+ * - <b>Signal</b>, an events mask is directly ORed to the mask of
39+ * the signaled thread.
4040 * - <b>Broadcast</b>, each thread registered on an Event Source is
4141 * signaled with the events specified in its Event Listener.
4242 * - <b>Dispatch</b>, an events mask is scanned and for each bit set
@@ -50,8 +50,8 @@
5050 * An unlimited number of Event Sources can exists in a system and
5151 * each thread can be listening on an unlimited number of
5252 * them.
53- * @pre In order to use the Events APIs the @p CH_CFG_USE_EVENTS option must be
54- * enabled in @p chconf.h.
53+ * @pre In order to use the Events APIs the @p CH_CFG_USE_EVENTS option
54+ * must be enabled in @p chconf.h.
5555 * @post Enabling events requires 1-4 (depending on the architecture)
5656 * extra bytes in the @p thread_t structure.
5757 * @{
Show on old repository browser