Documentation update for xEventGroupClearBitsFromISR (#432)
* Documented the correct use of xEventGroupClearBitsFromISR * removed typo
This commit is contained in:
parent
481c722ef3
commit
f5df2c140c
@ -378,6 +378,12 @@ EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
|
|||||||
* timer task to have the clear operation performed in the context of the timer
|
* timer task to have the clear operation performed in the context of the timer
|
||||||
* task.
|
* task.
|
||||||
*
|
*
|
||||||
|
* @note If this function returns pdPASS then the timer task is ready to run
|
||||||
|
* and a portYIELD_FROM_ISR(pdTRUE) should be executed to perform the needed
|
||||||
|
* clear on the event group. This behavior is different from
|
||||||
|
* xEventGroupSetBitsFromISR because the parameter xHigherPriorityTaskWoken is
|
||||||
|
* not present.
|
||||||
|
*
|
||||||
* @param xEventGroup The event group in which the bits are to be cleared.
|
* @param xEventGroup The event group in which the bits are to be cleared.
|
||||||
*
|
*
|
||||||
* @param uxBitsToClear A bitwise value that indicates the bit or bits to clear.
|
* @param uxBitsToClear A bitwise value that indicates the bit or bits to clear.
|
||||||
@ -407,6 +413,7 @@ EventBits_t xEventGroupClearBits( EventGroupHandle_t xEventGroup,
|
|||||||
* if( xResult == pdPASS )
|
* if( xResult == pdPASS )
|
||||||
* {
|
* {
|
||||||
* // The message was posted successfully.
|
* // The message was posted successfully.
|
||||||
|
* portYIELD_FROM_ISR(pdTRUE);
|
||||||
* }
|
* }
|
||||||
* }
|
* }
|
||||||
* @endcode
|
* @endcode
|
||||||
|
Reference in New Issue
Block a user