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
This commit is contained in:
Simon Werner 2017-09-08 11:08:34 +12:00 committed by Angus Gratton
parent 76db44e8ce
commit 45ad0cdda2

View file

@ -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
*