FreeRTOS/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-10-19 11:18:24 +08:00
Code Issues Releases Wiki Activity

Remove unmatched braces in MessageBuffer pre tags (#256)

Browse Source 
Co-authored-by: Gaurav-Aggarwal-AWS <33462878+aggarg@users.noreply.github.com>
This commit is contained in:
milesfrain
2021-02-10 21:41:05 -08:00
committed by GitHub
parent a4b2e0c3f3
commit 5b9549ab82
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/message_buffer.h
View File

@@ -630,7 +630,7 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer ) );
* BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer );
* </pre>
*
* Tests to see if a message buffer is full. A message buffer is full if it
@@ -648,7 +648,7 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer ) );
* BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer );
* </pre>
*
* Tests to see if a message buffer is empty (does not contain any messages).
@@ -690,7 +690,7 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* size_t xMessageBufferSpaceAvailable( MessageBufferHandle_t xMessageBuffer ) );
* size_t xMessageBufferSpaceAvailable( MessageBufferHandle_t xMessageBuffer );
* </pre>
* Returns the number of bytes of free space in the message buffer.
*
@@ -714,7 +714,7 @@ typedef void * MessageBufferHandle_t;
/**
* message_buffer.h
* <pre>
* size_t xMessageBufferNextLengthBytes( MessageBufferHandle_t xMessageBuffer ) );
* size_t xMessageBufferNextLengthBytes( MessageBufferHandle_t xMessageBuffer );
* </pre>
* Returns the length (in bytes) of the next message in a message buffer.
* Useful if xMessageBufferReceive() returned 0 because the size of the buffer