Minor code review suggestion

aggarg · aggarg · commit 9690251a10b6 · 2024-04-16T12:26:32.000Z
Signed-off-by: Gaurav Aggarwal &lt;aggarg@amazon.com&gt;
diff --git a/include/message_buffer.h b/include/message_buffer.h
@@ -795,7 +795,7 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
  * BaseType_t xMessageBufferResetFromISR( MessageBufferHandle_t xMessageBuffer );
  * @endcode
  *
- * An interrupt safe version of the API function that resets the stream buffer.
+ * An interrupt safe version of the API function that resets the message buffer.
  * Resets a message buffer to its initial empty state, discarding any message it
  * contained.
  *

Original file line number	Diff line number	Diff line change
`@@ -795,7 +795,7 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;`
`795`	`795`	`* BaseType_t xMessageBufferResetFromISR( MessageBufferHandle_t xMessageBuffer );`
`796`	`796`	`* @endcode`
`797`	`797`	`*`
`798`		`- * An interrupt safe version of the API function that resets the stream buffer.`
	`798`	`+ * An interrupt safe version of the API function that resets the message buffer.`
`799`	`799`	`* Resets a message buffer to its initial empty state, discarding any message it`
`800`	`800`	`* contained.`
`801`	`801`	`*`