Documentation-related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@13425 27425a3e-05d8-49a3-a47f-9c15f0e5edd8
This commit is contained in:
Giovanni Di Sirio 2020-03-15 13:29:36 +00:00
parent 0704ffbb3e
commit d9a0b13c96
2 changed files with 3 additions and 17 deletions

View File

@ -227,11 +227,6 @@ typedef void (*evhandler_t)(eventid_t id);
*
* @param[in] events events that the function should wait
* for, @p ALL_EVENTS enables all the events
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @return The mask of the lowest event id served and cleared.
* @retval 0 if the operation has timed out.
*
@ -245,13 +240,8 @@ typedef void (*evhandler_t)(eventid_t id);
* @p mask to become pending then the events are cleared and
* returned.
*
* @param[in] mask mask of the event flags that the function should wait
* @param[in] events events that the function should wait
* for, @p ALL_EVENTS enables all the events
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @return The mask of the served and cleared events.
* @retval 0 if the operation has timed out.
*
@ -264,13 +254,8 @@ typedef void (*evhandler_t)(eventid_t id);
* @details The function waits for all the events specified in @p mask to
* become pending then the events are cleared and returned.
*
* @param[in] mask mask of the event flags that the function should wait
* @param[in] events events that the function should wait
* for, @p ALL_EVENTS enables all the events
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @return The mask of the served and cleared events.
* @retval 0 if the operation has timed out.
*

View File

@ -88,6 +88,7 @@ thread_t *nil_find_thread(tstate_t state, void *p) {
* @param[in] cnt number of threads to be readied as a negative number,
* non negative numbers are ignored
* @param[in] msg the wakeup message
* @return The number of readied threads.
*
* @notapi
*/