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

diff --git a/components/driver/include/driver/uart.h b/components/driver/include/driver/uart.h
index de1b619f93059b9164fd4ae078bf786e2b4324f8..5cf3d08ec0434e613cee2dc73917b1bf01bc5a10 100644 (file)
--- 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
  *