Skip to content

Commit 5e45472

Browse files
authored
fixed documentation for ulTaskNotifyTake() and ulTaskNotifyTakeIndexed() (#269)
1 parent 4fde4a8 commit 5e45472

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

include/task.h

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1934,9 +1934,8 @@ uint32_t ulTaskGetIdleRunTimeCounter( void ) PRIVILEGED_FUNCTION;
19341934
* that way task notifications can be used to send data to a task, or be used as
19351935
* light weight and fast binary or counting semaphores.
19361936
*
1937-
* A task can use xTaskNotifyWaitIndexed() to [optionally] block to wait for a
1938-
* notification to be pending, or ulTaskNotifyTakeIndexed() to [optionally] block
1939-
* to wait for a notification value to have a non-zero value. The task does
1937+
* A task can use xTaskNotifyWaitIndexed() or ulTaskNotifyTakeIndexed() to
1938+
* [optionally] block to wait for a notification to be pending. The task does
19401939
* not consume any CPU time while it is in the Blocked state.
19411940
*
19421941
* A notification sent to a task will remain pending until it is cleared by the
@@ -2522,8 +2521,8 @@ void vTaskGenericNotifyGiveFromISR( TaskHandle_t xTaskToNotify,
25222521
* value acts like a counting semaphore.
25232522
*
25242523
* A task can use ulTaskNotifyTakeIndexed() to [optionally] block to wait for
2525-
* the task's notification value to be non-zero. The task does not consume any
2526-
* CPU time while it is in the Blocked state.
2524+
* a notification. The task does not consume any CPU time while it is in the
2525+
* Blocked state.
25272526
*
25282527
* Where as xTaskNotifyWaitIndexed() will return when a notification is pending,
25292528
* ulTaskNotifyTakeIndexed() will return when the task's notification value is

0 commit comments

Comments
 (0)