len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2026-02-23 18:45:27 -05:00
Code Issues Projects Releases Packages Wiki Activity

Correct minor mistakes in code comments (#1371)

Browse source 
This commit revises some comments in the following files:
    - event_groups.c
    - include/queue.h
    - include/task.h

Co-authored-by: Kody Stribrny <89810515+kstribrnAmzn@users.noreply.github.com>
This commit is contained in:
wirelinker 2026-02-21 03:11:15 +08:00 • committed by GitHub
parent 850d29477c
commit 0f8efd98cc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
event_groups.c
View file

@ -72,7 +72,7 @@
* The wait condition is defined by xWaitForAllBits. If xWaitForAllBits is * The wait condition is defined by xWaitForAllBits. If xWaitForAllBits is
* pdTRUE then the wait condition is met if all the bits set in uxBitsToWaitFor * pdTRUE then the wait condition is met if all the bits set in uxBitsToWaitFor
* are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the * are also set in uxCurrentEventBits. If xWaitForAllBits is pdFALSE then the
* wait condition is met if any of the bits set in uxBitsToWait for are also set * wait condition is met if any of the bits set in uxBitsToWaitFor are also set
* in uxCurrentEventBits. * in uxCurrentEventBits.
*/ */
static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits, static BaseType_t prvTestWaitCondition( const EventBits_t uxCurrentEventBits,

8
include/queue.h
View file

@ -202,8 +202,8 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
* char ucData[ 20 ]; * char ucData[ 20 ];
* }; * };
* *
#define QUEUE_LENGTH 10 * #define QUEUE_LENGTH 10
#define ITEM_SIZE sizeof( uint32_t ) * #define ITEM_SIZE sizeof( uint32_t )
* *
* // xQueueBuffer will hold the queue structure. * // xQueueBuffer will hold the queue structure.
* StaticQueue_t xQueueBuffer; * StaticQueue_t xQueueBuffer;
@ -217,8 +217,8 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
* QueueHandle_t xQueue1; * QueueHandle_t xQueue1;
* *
* // Create a queue capable of containing 10 uint32_t values. * // Create a queue capable of containing 10 uint32_t values.
* xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold. * xQueue1 = xQueueCreateStatic( QUEUE_LENGTH, // The number of items the queue can hold.
* ITEM_SIZE // The size of each item in the queue * ITEM_SIZE, // The size of each item in the queue.
* &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue. * &( ucQueueStorage[ 0 ] ), // The buffer that will hold the items in the queue.
* &xQueueBuffer ); // The buffer that will hold the queue structure. * &xQueueBuffer ); // The buffer that will hold the queue structure.
* *

8
include/task.h
View file

@ -2617,9 +2617,8 @@ char * pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION;
* notification value at that index being updated. ulValue is not used and * notification value at that index being updated. ulValue is not used and
* xTaskNotifyIndexed() always returns pdPASS in this case. * xTaskNotifyIndexed() always returns pdPASS in this case.
* *
* pulPreviousNotificationValue - * @param pulPreviousNotificationValue Can be used to pass out the subject
* Can be used to pass out the subject task's notification value before any * task's notification value before any bits are modified by the notify function.
* bits are modified by the notify function.
* *
* @return Dependent on the value of eAction. See the description of the * @return Dependent on the value of eAction. See the description of the
* eAction parameter. * eAction parameter.
@ -2764,6 +2763,9 @@ BaseType_t xTaskGenericNotify( TaskHandle_t xTaskToNotify,
* updated. ulValue is not used and xTaskNotify() always returns pdPASS in * updated. ulValue is not used and xTaskNotify() always returns pdPASS in
* this case. * this case.
* *
* @param pulPreviousNotificationValue Can be used to pass out the subject
* task's notification value before any bits are modified by the notify function.
*
* @param pxHigherPriorityTaskWoken xTaskNotifyFromISR() will set * @param pxHigherPriorityTaskWoken xTaskNotifyFromISR() will set
* *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the * *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the
* task to which the notification was sent to leave the Blocked state, and the * task to which the notification was sent to leave the Blocked state, and the