Skip to content

Commit 6a73c99

Browse files
committed
Correct minor mistakes in code comments
This commit revises some comments in the following files: - event_groups.c - include/queue.h - include/task.h
1 parent 6cd736c commit 6a73c99

3 files changed

Lines changed: 12 additions & 10 deletions

File tree

event_groups.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
* The wait condition is defined by xWaitForAllBits. If xWaitForAllBits is
7373
* pdTRUE then the wait condition is met if all the bits set in uxBitsToWaitFor
7474
* are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the
75-
* wait condition is met if any of the bits set in uxBitsToWait for are also set
75+
* wait condition is met if any of the bits set in uxBitsToWaitFor are also set
7676
* in uxCurrentEventBits.
7777
*/
7878
static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits,

include/queue.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,8 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
202202
* char ucData[ 20 ];
203203
* };
204204
*
205-
#define QUEUE_LENGTH 10
206-
#define ITEM_SIZE sizeof( uint32_t )
205+
* #define QUEUE_LENGTH 10
206+
* #define ITEM_SIZE sizeof( uint32_t )
207207
*
208208
* // xQueueBuffer will hold the queue structure.
209209
* StaticQueue_t xQueueBuffer;
@@ -217,10 +217,10 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
217217
* QueueHandle_t xQueue1;
218218
*
219219
* // Create a queue capable of containing 10 uint32_t values.
220-
* xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold.
221-
* ITEM_SIZE // The size of each item in the queue
222-
* &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.
223-
* &xQueueBuffer ); // The buffer that will hold the queue structure.
220+
* xQueue1 = xQueueCreateStatic( QUEUE_LENGTH, // The number of items the queue can hold.
221+
* ITEM_SIZE, // The size of each item in the queue.
222+
* &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.
223+
* &xQueueBuffer ); // The buffer that will hold the queue structure.
224224
*
225225
* // The queue is guaranteed to be created successfully as no dynamic memory
226226
* // allocation is used. Therefore xQueue1 is now a handle to a valid queue.

include/task.h

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2617,9 +2617,8 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
26172617
* notification value at that index being updated. ulValue is not used and
26182618
* xTaskNotifyIndexed() always returns pdPASS in this case.
26192619
*
2620-
* pulPreviousNotificationValue -
2621-
* Can be used to pass out the subject task's notification value before any
2622-
* bits are modified by the notify function.
2620+
* @param pulPreviousNotificationValue Can be used to pass out the subject
2621+
* task's notification value before any bits are modified by the notify function.
26232622
*
26242623
* @return Dependent on the value of eAction. See the description of the
26252624
* eAction parameter.
@@ -2764,6 +2763,9 @@ BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify,
27642763
* updated. ulValue is not used and xTaskNotify() always returns pdPASS in
27652764
* this case.
27662765
*
2766+
* @param pulPreviousNotificationValue Can be used to pass out the subject
2767+
* task's notification value before any bits are modified by the notify function.
2768+
*
27672769
* @param pxHigherPriorityTaskWoken xTaskNotifyFromISR() will set
27682770
* *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the
27692771
* task to which the notification was sent to leave the Blocked state, and the

0 commit comments

Comments
 (0)