alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/ring_buf_get_info_api_wrong' into 'master'

Browse Source 
docs(ringbuf): fixed mistake in vRingbufferGetInfo API parameter doc

See merge request espressif/esp-idf!28427
This commit is contained in:
Marius Vikhammer 2024-01-16 09:34:20 +08:00
commit 0b9c0c188a
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/esp_ringbuf/include/freertos/ringbuf.h
View File

@ -492,7 +492,7 @@ BaseType_t xRingbufferRemoveFromQueueSetRead(RingbufHandle_t xRingbuffer, QueueS
* free/read/write/acquire pointer positions, and number of items waiting to be retrieved.
* Arguments can be set to NULL if they are not required.
*
* @param[in] xRingbuffer Ring buffer to remove from the queue set
* @param[in] xRingbuffer Ring buffer handle
* @param[out] uxFree Pointer use to store free pointer position
* @param[out] uxRead Pointer use to store read pointer position
* @param[out] uxWrite Pointer use to store write pointer position