From 7064ad8abb92d34c9cbe5b834e0fd327c5add986 Mon Sep 17 00:00:00 2001 From: Sudeep Mohanty Date: Mon, 9 Dec 2024 09:30:04 +0530 Subject: [PATCH] docs(esp_ringbuf): Fixed incorrect documentation for xRingBufferSendComplete() Closes https://github.com/espressif/esp-idf/issues/14990 --- docs/en/api-reference/system/freertos_additions.rst | 2 +- docs/zh_CN/api-reference/system/freertos_additions.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-reference/system/freertos_additions.rst b/docs/en/api-reference/system/freertos_additions.rst index a4e8ea8f11..11de9a32cf 100644 --- a/docs/en/api-reference/system/freertos_additions.rst +++ b/docs/en/api-reference/system/freertos_additions.rst @@ -111,7 +111,7 @@ The following example demonstrates the usage of :cpp:func:`xRingbufferSendAcquir .buf = item->buf, }; //Actually send to the ring buffer for consumer to use - res = xRingbufferSendComplete(buf_handle, &item); + res = xRingbufferSendComplete(buf_handle, (void *)item); if (res != pdTRUE) { printf("Failed to send item\n"); } diff --git a/docs/zh_CN/api-reference/system/freertos_additions.rst b/docs/zh_CN/api-reference/system/freertos_additions.rst index eb2f0f41b4..d9f6b75474 100644 --- a/docs/zh_CN/api-reference/system/freertos_additions.rst +++ b/docs/zh_CN/api-reference/system/freertos_additions.rst @@ -111,7 +111,7 @@ ESP-IDF 环形 buffer 是一个典型的 FIFO buffer,支持任意大小的数 .buf = item->buf, }; //实际发送到环形 buffer 以供使用 - res = xRingbufferSendComplete(buf_handle, &item); + res = xRingbufferSendComplete(buf_handle, (void *)item); if (res != pdTRUE) { printf("Failed to send item\n"); }