Skip to content

Commit 4036c96

Browse files
committed
example usage is actually correct, so remove the -1. but update the incorrect parameter description for pucStreamBufferStorageArea and pucMessageBufferStorageArea.
1 parent ddf9d25 commit 4036c96

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

include/message_buffer.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ typedef void * MessageBufferHandle_t;
165165
* stored in the message buffer is actually (xBufferSizeBytes - 1).
166166
*
167167
* @param pucMessageBufferStorageArea Must point to a uint8_t array that is at
168-
* least xBufferSizeBytes + 1 big. This is the array to which messages are
168+
* least xBufferSizeBytes big. This is the array to which messages are
169169
* copied when they are written to the message buffer.
170170
*
171171
* @param pxStaticMessageBuffer Must point to a variable of type
@@ -194,7 +194,7 @@ typedef void * MessageBufferHandle_t;
194194
* {
195195
* MessageBufferHandle_t xMessageBuffer;
196196
*
197-
* xMessageBuffer = xMessageBufferCreateStatic( sizeof( ucStorageBuffer ) - 1,
197+
* xMessageBuffer = xMessageBufferCreateStatic( sizeof( ucStorageBuffer ),
198198
* ucStorageBuffer,
199199
* &xMessageBufferStruct );
200200
*

include/stream_buffer.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
172172
* that is greater than the buffer size.
173173
*
174174
* @param pucStreamBufferStorageArea Must point to a uint8_t array that is at
175-
* least xBufferSizeBytes + 1 big. This is the array to which streams are
175+
* least xBufferSizeBytes big. This is the array to which streams are
176176
* copied when they are written to the stream buffer.
177177
*
178178
* @param pxStaticStreamBuffer Must point to a variable of type
@@ -202,7 +202,7 @@ typedef struct StreamBufferDef_t * StreamBufferHandle_t;
202202
* StreamBufferHandle_t xStreamBuffer;
203203
* const size_t xTriggerLevel = 1;
204204
*
205-
* xStreamBuffer = xStreamBufferCreateStatic( sizeof( ucStorageBuffer ) - 1,
205+
* xStreamBuffer = xStreamBufferCreateStatic( sizeof( ucStorageBuffer ),
206206
* xTriggerLevel,
207207
* ucStorageBuffer,
208208
* &xStreamBufferStruct );

0 commit comments

Comments
 (0)