Skip to content

Commit

Permalink
fixes in queue documentation (FreeRTOS#382)
Browse files Browse the repository at this point in the history
Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>
  • Loading branch information
zikalino and aggarg authored Aug 13, 2021
1 parent 6ba8aa6 commit 0b1e9d7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions include/queue.h
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
* QueueHandle_t xQueueCreateStatic(
* UBaseType_t uxQueueLength,
* UBaseType_t uxItemSize,
* uint8_t *pucQueueStorageBuffer,
* uint8_t *pucQueueStorage,
* StaticQueue_t *pxQueueBuffer
* );
* </pre>
Expand All @@ -182,11 +182,11 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
* that will be copied for each posted item. Each item on the queue must be
* the same size.
*
* @param pucQueueStorageBuffer If uxItemSize is not zero then
* pucQueueStorageBuffer must point to a uint8_t array that is at least large
* @param pucQueueStorage If uxItemSize is not zero then
* 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
* 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
* will be used to hold the queue's data structure.
Expand Down Expand Up @@ -214,7 +214,7 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
*
* void vATask( void *pvParameters )
* {
* QueueHandle_t xQueue1;
* QueueHandle_t xQueue1;
*
* // Create a queue capable of containing 10 uint32_t values.
* xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold.
Expand Down Expand Up @@ -1501,7 +1501,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION;
* is the handle returned by a call to xQueueCreate(). Semaphore and mutex
* 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
* stores a pointer to the string - so the string must be persistent (global or
* preferably in ROM/Flash), not on the stack.
Expand Down

0 comments on commit 0b1e9d7

Please sign in to comment.