From 45ad0cdda25db970c7ee8ad61b8def0a603679c6 Mon Sep 17 00:00:00 2001 From: Simon Werner Date: Fri, 8 Sep 2017 11:08:34 +1200 Subject: [PATCH] Improved `uart_flush()` documentation. Improved `uart_flush()` documentation based on this discussion: https://esp32.com/viewtopic.php?f=13&t=2804&p=13377&hilit=uart_flush#p13373 Merges https://github.com/espressif/esp-idf/pull/970 --- components/driver/include/driver/uart.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/driver/include/driver/uart.h b/components/driver/include/driver/uart.h index de1b619f93..5cf3d08ec0 100644 --- a/components/driver/include/driver/uart.h +++ b/components/driver/include/driver/uart.h @@ -601,7 +601,7 @@ int uart_write_bytes_with_break(uart_port_t uart_num, const char* src, size_t si int uart_read_bytes(uart_port_t uart_num, uint8_t* buf, uint32_t length, TickType_t ticks_to_wait); /** - * @brief UART ring buffer flush + * @brief UART ring buffer flush. This will discard all data in the UART RX buffer. * * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2 * -- 2.40.0