Merge branch 'docs/update_uart_read_bytes_description' into 'master'

docs: update the description of uart_read_bytes

Closes DOC-3798

See merge request espressif/esp-idf!20611
This commit is contained in:
morris
2022-10-14 21:54:44 +08:00

View File

@@ -538,7 +538,7 @@ int uart_write_bytes_with_break(uart_port_t uart_num, const void* src, size_t si
* *
* @return * @return
* - (-1) Error * - (-1) Error
* - OTHERS (>=0) The number of bytes read from UART FIFO * - OTHERS (>=0) The number of bytes read from UART buffer
*/ */
int uart_read_bytes(uart_port_t uart_num, void* buf, uint32_t length, TickType_t ticks_to_wait); int uart_read_bytes(uart_port_t uart_num, void* buf, uint32_t length, TickType_t ticks_to_wait);