fix example usage of xMessageBufferCreateStatic and xStreamBufferCrea… (#380)
Example usage is actually correct, so remove the -1. but update
the incorrect parameter description for pucStreamBufferStorageArea
and pucMessageBufferStorageArea.
diff --git a/include/message_buffer.h b/include/message_buffer.h
index b7428ad..c569d63 100644
--- a/include/message_buffer.h
+++ b/include/message_buffer.h
@@ -165,7 +165,7 @@
* stored in the message buffer is actually (xBufferSizeBytes - 1).
*
* @param pucMessageBufferStorageArea Must point to a uint8_t array that is at
- * least xBufferSizeBytes + 1 big. This is the array to which messages are
+ * least xBufferSizeBytes big. This is the array to which messages are
* copied when they are written to the message buffer.
*
* @param pxStaticMessageBuffer Must point to a variable of type
@@ -194,8 +194,8 @@
* {
* MessageBufferHandle_t xMessageBuffer;
*
- * xMessageBuffer = xMessageBufferCreateStatic( sizeof( ucBufferStorage ),
- * ucBufferStorage,
+ * xMessageBuffer = xMessageBufferCreateStatic( sizeof( ucStorageBuffer ),
+ * ucStorageBuffer,
* &xMessageBufferStruct );
*
* // As neither the pucMessageBufferStorageArea or pxStaticMessageBuffer
diff --git a/include/stream_buffer.h b/include/stream_buffer.h
index 9d3c953..061f018 100644
--- a/include/stream_buffer.h
+++ b/include/stream_buffer.h
@@ -172,7 +172,7 @@
* that is greater than the buffer size.
*
* @param pucStreamBufferStorageArea Must point to a uint8_t array that is at
- * least xBufferSizeBytes + 1 big. This is the array to which streams are
+ * least xBufferSizeBytes big. This is the array to which streams are
* copied when they are written to the stream buffer.
*
* @param pxStaticStreamBuffer Must point to a variable of type
@@ -202,9 +202,9 @@
* StreamBufferHandle_t xStreamBuffer;
* const size_t xTriggerLevel = 1;
*
- * xStreamBuffer = xStreamBufferCreateStatic( sizeof( ucBufferStorage ),
+ * xStreamBuffer = xStreamBufferCreateStatic( sizeof( ucStorageBuffer ),
* xTriggerLevel,
- * ucBufferStorage,
+ * ucStorageBuffer,
* &xStreamBufferStruct );
*
* // As neither the pucStreamBufferStorageArea or pxStaticStreamBuffer
