From b3dd5cb243be3386dc32a32e0656a6a3ec4260fd Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Fri, 12 Jan 2024 09:54:47 +0800 Subject: [PATCH] docs(ringbuf): fixed mistake in vRingbufferGetInfo API parameter doc --- components/esp_ringbuf/include/freertos/ringbuf.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/esp_ringbuf/include/freertos/ringbuf.h b/components/esp_ringbuf/include/freertos/ringbuf.h index 942b3262b0..79880ce311 100644 --- a/components/esp_ringbuf/include/freertos/ringbuf.h +++ b/components/esp_ringbuf/include/freertos/ringbuf.h @@ -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