diff options
Diffstat (limited to 'src/chevents.c')
| -rw-r--r-- | src/chevents.c | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/src/chevents.c b/src/chevents.c index af42a36b3..cddc2215a 100644 --- a/src/chevents.c +++ b/src/chevents.c @@ -26,8 +26,8 @@ #ifdef CH_USE_EVENTS
/**
* Registers an Event Listener on an Event Source.
- * @param esp pointer to the \p EventSource structure
- * @param elp pointer to the \p EventListener structure
+ * @param esp pointer to the @p EventSource structure
+ * @param elp pointer to the @p EventListener structure
* @param emask the mask of event flags to be pended to the thread when the
* event source is broadcasted
* @note Multiple Event Listeners can specify the same bits to be pended.
@@ -46,8 +46,8 @@ void chEvtRegisterMask(EventSource *esp, EventListener *elp, eventmask_t emask) /**
* Unregisters an Event Listener from its Event Source.
- * @param esp pointer to the \p EventSource structure
- * @param elp pointer to the \p EventListener structure
+ * @param esp pointer to the @p EventSource structure
+ * @param elp pointer to the @p EventListener structure
* @note If the event listener is not registered on the specified event source
* then the function does nothing.
* @note For optimal performance it is better to perform the unregister
@@ -89,7 +89,7 @@ eventmask_t chEvtClear(eventmask_t mask) { /**
* Makes an events mask pending in the current thread, this is \b much faster than
- * using \p chEvtBroadcast().
+ * using @p chEvtBroadcast().
* @param mask the events to be pended
* @return The current pending events mask.
*/
@@ -105,7 +105,7 @@ eventmask_t chEvtPend(eventmask_t mask) { /**
* Signals all the Event Listeners registered on the specified Event Source.
- * @param esp pointer to the \p EventSource structure
+ * @param esp pointer to the @p EventSource structure
*/
void chEvtBroadcast(EventSource *esp) {
@@ -119,7 +119,7 @@ void chEvtBroadcast(EventSource *esp) { /**
* Signals all the Event Listeners registered on the specified Event Source.
- * @param esp pointer to the \p EventSource structure
+ * @param esp pointer to the @p EventSource structure
* @note This function does not reschedule.
*/
void chEvtBroadcastI(EventSource *esp) {
@@ -143,7 +143,7 @@ void chEvtBroadcastI(EventSource *esp) { /**
* Invokes the event handlers associated with a mask.
* @param mask mask of the events to be dispatched
- * @param handlers an array of \p evhandler_t. The array must be
+ * @param handlers an array of @p evhandler_t. The array must be
* have indexes from zero up the higher registered event
* identifier.
*/
@@ -163,10 +163,10 @@ void chEvtDispatch(const evhandler_t handlers[], eventmask_t mask) { #if defined(CH_OPTIMIZE_SPEED) || !defined(CH_USE_EVENTS_TIMEOUT) || \
defined(__DOXIGEN__)
/**
- * A pending event among those specified in \p ewmask is selected, cleared and
+ * A pending event among those specified in @p ewmask is selected, cleared and
* its mask returned.
* @param ewmask mask of the events that the function should wait for,
- * \p ALL_EVENTS enables all the events
+ * @p ALL_EVENTS enables all the events
* @return The mask of the lowest id served and cleared event.
* @note One and only one event is served in the function, the one with the
* lowest event id. The function is meant to be invoked into a loop in
@@ -193,10 +193,10 @@ eventmask_t chEvtWaitOne(eventmask_t ewmask) { /**
* Waits for any of the specified events.
- * The function waits for any event among those specified in \p ewmask to
+ * 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
+ * @p ALL_EVENTS enables all the events
* @return The mask of the served and cleared events.
*/
eventmask_t chEvtWaitAny(eventmask_t ewmask) {
@@ -217,7 +217,7 @@ eventmask_t chEvtWaitAny(eventmask_t ewmask) { /**
* Waits for all the specified event flags then clears them.
- * The function waits for all the events specified in \p ewmask to become
+ * The function waits for all the events specified in @p ewmask to become
* pending then the events are cleared and returned.
* @param ewmask mask of the event ids that the function should wait for
* @return The mask of the served and cleared events.
@@ -240,10 +240,10 @@ eventmask_t chEvtWaitAll(eventmask_t ewmask) { #ifdef CH_USE_EVENTS_TIMEOUT
/**
* Waits for a single event.
- * A pending event among those specified in \p ewmask is selected, cleared and
+ * A pending event among those specified in @p ewmask is selected, cleared and
* its mask returned.
* @param ewmask mask of the events that the function should wait for,
- * \p ALL_EVENTS enables all the events
+ * @p ALL_EVENTS enables all the events
* @param time the number of ticks before the operation timouts
* @return The mask of the lowest id served and cleared event.
* @retval 0 if the specified timeout expired.
@@ -273,10 +273,10 @@ eventmask_t chEvtWaitOneTimeout(eventmask_t ewmask, systime_t time) { /**
* Waits for any of the specified events.
- * The function waits for any event among those specified in \p ewmask to
+ * 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
+ * @p ALL_EVENTS enables all the events
* @param time the number of ticks before the operation timouts
* @return The mask of the served and cleared events.
* @retval 0 if the specified timeout expired.
@@ -300,7 +300,7 @@ eventmask_t chEvtWaitAnyTimeout(eventmask_t ewmask, systime_t time) { /**
* Waits for all the specified event flags then clears them.
- * The function waits for all the events specified in \p ewmask to become
+ * The function waits for all the events specified in @p ewmask to become
* pending then the events are cleared and returned.
* @param ewmask mask of the event ids that the function should wait for
* @param time the number of ticks before the operation timouts
|