Skip to content

Commit 976db5e

Browse files
committed
fixes in queue documentation
1 parent b97bb48 commit 976db5e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

include/queue.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
155155
* QueueHandle_t xQueueCreateStatic(
156156
* UBaseType_t uxQueueLength,
157157
* UBaseType_t uxItemSize,
158-
* uint8_t *pucQueueStorageBuffer,
158+
* uint8_t *pucQueueStorage,
159159
* StaticQueue_t *pxQueueBuffer
160160
* );
161161
* </pre>
@@ -182,11 +182,11 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
182182
* that will be copied for each posted item. Each item on the queue must be
183183
* the same size.
184184
*
185-
* @param pucQueueStorageBuffer If uxItemSize is not zero then
186-
* pucQueueStorageBuffer must point to a uint8_t array that is at least large
185+
* @param pucQueueStorage If uxItemSize is not zero then
186+
* pucQueueStorage must point to a uint8_t array that is at least large
187187
* enough to hold the maximum number of items that can be in the queue at any
188188
* one time - which is ( uxQueueLength * uxItemsSize ) bytes. If uxItemSize is
189-
* zero then pucQueueStorageBuffer can be NULL.
189+
* zero then pucQueueStorage can be NULL.
190190
*
191191
* @param pxQueueBuffer Must point to a variable of type StaticQueue_t, which
192192
* will be used to hold the queue's data structure.
@@ -214,7 +214,7 @@ typedef struct QueueDefinition * QueueSetMemberHandle_t;
214214
*
215215
* void vATask( void *pvParameters )
216216
* {
217-
* QueueHandle_t xQueue1;
217+
* QueueHandle_t xQueue1;
218218
*
219219
* // Create a queue capable of containing 10 uint32_t values.
220220
* xQueue1 = xQueueCreate( QUEUE_LENGTH, // The number of items the queue can hold.
@@ -1501,7 +1501,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION;
15011501
* is the handle returned by a call to xQueueCreate(). Semaphore and mutex
15021502
* handles can also be passed in here.
15031503
*
1504-
* @param pcName The name to be associated with the handle. This is the
1504+
* @param pcQueueName The name to be associated with the handle. This is the
15051505
* name that the kernel aware debugger will display. The queue registry only
15061506
* stores a pointer to the string - so the string must be persistent (global or
15071507
* preferably in ROM/Flash), not on the stack.

0 commit comments

Comments
 (0)