docs: update the description of uart_read_bytes

This commit is contained in:
Linda 2022-10-14 15:55:40 +08:00
parent 40fc703a2b
commit 837d29cca0

View File

@ -538,7 +538,7 @@ int uart_write_bytes_with_break(uart_port_t uart_num, const void* src, size_t si
*
* @return
* - (-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);