Documentation update for xEventGroupClearBitsFromISR (#432)
* Documented the correct use of xEventGroupClearBitsFromISR
* removed typo
diff --git a/include/event_groups.h b/include/event_groups.h
index 6807002..48c8fdb 100644
--- a/include/event_groups.h
+++ b/include/event_groups.h
@@ -378,6 +378,12 @@
* timer task to have the clear operation performed in the context of the timer
* 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 uxBitsToClear A bitwise value that indicates the bit or bits to clear.
@@ -407,6 +413,7 @@
* if( xResult == pdPASS )
* {
* // The message was posted successfully.
+ * portYIELD_FROM_ISR(pdTRUE);
* }
* }
* @endcode
