]> granicus.if.org Git - esp-idf/commitdiff
revise the explain of a parameter(brk_len) in uart driver file
authorchenjianqiang <chenjianqiang@espressif.com>
Mon, 14 May 2018 11:47:16 +0000 (19:47 +0800)
committerchenjianqiang <chenjianqiang@espressif.com>
Mon, 14 May 2018 11:47:16 +0000 (19:47 +0800)
components/driver/include/driver/uart.h

index f6419c0e8770f3b70140bac3114acad7a0e0e454..08c398f61f842b7af08049ddcdc05ca2998f285e 100644 (file)
@@ -594,8 +594,7 @@ int uart_write_bytes(uart_port_t uart_num, const char* src, size_t size);
  * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2
  * @param src   data buffer address
  * @param size  data length to send
- * @param brk_len break signal length (unit: the time it takes to send a complete byte
-                  including start, stop and parity bits at current_baudrate)
+ * @param brk_len break signal duration(unit: the time it takes to send one bit at current baudrate)
  *
  * @return
  *     - (-1) Parameter error