len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-09-13 01:27:48 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fix inaccuracies in prvWriteBytesToBuffer description

Browse source
This commit is contained in:
Miles Frain 2021-02-18 15:07:35 -08:00
parent 1d4d16fd54
commit cda43dd4d8
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
stream_buffer.c
View file

@ -159,10 +159,9 @@ typedef struct StreamBufferDef_t /*lint !e9058 Style convention
static size_t prvBytesInBuffer( const StreamBuffer_t * const pxStreamBuffer ) PRIVILEGED_FUNCTION; static size_t prvBytesInBuffer( const StreamBuffer_t * const pxStreamBuffer ) PRIVILEGED_FUNCTION;
/* /*
* Add xCount bytes from pucData into the pxStreamBuffer message buffer. * Add xCount bytes from pucData into the pxStreamBuffer's data storage area.
* Returns the number of bytes written, which will either equal xCount in the * Assumes there is enough free space in the buffer.
* success case, or 0 if there was not enough space in the buffer (in which case * Always returns xCount, which is the number of bytes written.
* no data is written into the buffer).
*/ */
static size_t prvWriteBytesToBuffer( StreamBuffer_t * const pxStreamBuffer, static size_t prvWriteBytesToBuffer( StreamBuffer_t * const pxStreamBuffer,
const uint8_t * pucData, const uint8_t * pucData,