feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'docs/fix_ringbuf_doc_xringbuffersendcomplete' into 'master'

Browse Source 
docs(esp_ringbuf): Fixed incorrect documentation for xRingBufferSendComplete()

Closes IDFGH-14191

See merge request espressif/esp-idf!35497
This commit is contained in:
Sudeep Mohanty
2024-12-09 17:05:39 +08:00
parent d30af2fbdc 7064ad8abb
commit 2cddacd0ac
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/system/freertos_additions.rst
View File

@@ -111,7 +111,7 @@ The following example demonstrates the usage of :cpp:func:`xRingbufferSendAcquir
.buf = item->buf, .buf = item->buf,
}; };
//Actually send to the ring buffer for consumer to use //Actually send to the ring buffer for consumer to use
res = xRingbufferSendComplete(buf_handle, &item); res = xRingbufferSendComplete(buf_handle, (void *)item);
if (res != pdTRUE) { if (res != pdTRUE) {
printf("Failed to send item\n"); printf("Failed to send item\n");
} }

2
docs/zh_CN/api-reference/system/freertos_additions.rst
View File

@@ -111,7 +111,7 @@ ESP-IDF 环形 buffer 是一个典型的 FIFO buffer，支持任意大小的数
.buf = item->buf, .buf = item->buf,
}; };
//实际发送到环形 buffer 以供使用 //实际发送到环形 buffer 以供使用
res = xRingbufferSendComplete(buf_handle, &item); res = xRingbufferSendComplete(buf_handle, (void *)item);
if (res != pdTRUE) { if (res != pdTRUE) {
printf("Failed to send item\n"); printf("Failed to send item\n");
} }