len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-05-13 08:39:07 -04:00
Code Issues Packages Projects Releases Wiki Activity

fixes in queue documentation (#382)

Browse source 
Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>
This commit is contained in:
Zim Kalinowski 2021-08-13 09:15:57 +08:00 committed by GitHub
parent 6ba8aa63c1
commit 0b1e9d79c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/queue.h
View file

@ -155,7 +155,7 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
* QueueHandle_t xQueueCreateStatic( * QueueHandle_t xQueueCreateStatic(
* UBaseType_t uxQueueLength, * UBaseType_t uxQueueLength,
* UBaseType_t uxItemSize, * UBaseType_t uxItemSize,
* uint8_t *pucQueueStorageBuffer, * uint8_t *pucQueueStorage,
* StaticQueue_t *pxQueueBuffer * StaticQueue_t *pxQueueBuffer
* ); * );
* </pre> * </pre>
@ -182,11 +182,11 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
* that will be copied for each posted item. Each item on the queue must be * that will be copied for each posted item. Each item on the queue must be
* the same size. * the same size.
* *
* @param pucQueueStorageBuffer If uxItemSize is not zero then * @param pucQueueStorage If uxItemSize is not zero then
* pucQueueStorageBuffer must point to a uint8_t array that is at least large * pucQueueStorage must point to a uint8_t array that is at least large
* enough to hold the maximum number of items that can be in the queue at any * enough to hold the maximum number of items that can be in the queue at any
* one time - which is ( uxQueueLength * uxItemsSize ) bytes. If uxItemSize is * one time - which is ( uxQueueLength * uxItemsSize ) bytes. If uxItemSize is
* zero then pucQueueStorageBuffer can be NULL. * zero then pucQueueStorage can be NULL.
* *
* @param pxQueueBuffer Must point to a variable of type StaticQueue_t, which * @param pxQueueBuffer Must point to a variable of type StaticQueue_t, which
* will be used to hold the queue's data structure. * will be used to hold the queue's data structure.
@ -1501,7 +1501,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION;
* is the handle returned by a call to xQueueCreate(). Semaphore and mutex * is the handle returned by a call to xQueueCreate(). Semaphore and mutex
* handles can also be passed in here. * handles can also be passed in here.
* *
* @param pcName The name to be associated with the handle. This is the * @param pcQueueName The name to be associated with the handle. This is the
* name that the kernel aware debugger will display. The queue registry only * name that the kernel aware debugger will display. The queue registry only
* stores a pointer to the string - so the string must be persistent (global or * stores a pointer to the string - so the string must be persistent (global or
* preferably in ROM/Flash), not on the stack. * preferably in ROM/Flash), not on the stack.