uart: use same argument names in get/set functions

https://github.com/espressif/esp-idf/issues/105

diff --git a/components/driver/include/driver/uart.h b/components/driver/include/driver/uart.h
index 905c28826000d0e177ff97a972e352280f365300..1ddfcad9fae390c608c22e86678c5f587445b425 100644 (file)
--- a/components/driver/include/driver/uart.h
+++ b/components/driver/include/driver/uart.h
@@ -167,25 +167,25 @@ esp_err_t uart_get_word_length(uart_port_t uart_num, uart_word_length_t* data_bi
  * @brief Set UART stop bits.\r
  *\r
  * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- * @param bit_num  UART stop bits\r
+ * @param stop_bits  UART stop bits\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
  *     - ESP_FAIL Fail\r
  */\r
-esp_err_t uart_set_stop_bits(uart_port_t uart_num, uart_stop_bits_t bit_num);\r
+esp_err_t uart_set_stop_bits(uart_port_t uart_num, uart_stop_bits_t stop_bits);\r
 \r
 /**\r
  * @brief Set UART stop bits.\r
  *\r
  * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- * @param stop_bit  Pointer to accept value of UART stop bits.\r
+ * @param stop_bits  Pointer to accept value of UART stop bits.\r
  *\r
  * @return\r
  *     - ESP_FAIL Parameter error\r
  *     - ESP_OK   Success, result will be put in (*stop_bit)\r
  */\r
-esp_err_t uart_get_stop_bits(uart_port_t uart_num, uart_stop_bits_t* stop_bit);\r
+esp_err_t uart_get_stop_bits(uart_port_t uart_num, uart_stop_bits_t* stop_bits);\r
 \r
 /**\r
  * @brief Set UART parity.\r
@@ -216,13 +216,13 @@ esp_err_t uart_get_parity(uart_port_t uart_num, uart_parity_t* parity_mode);
  * @brief Set UART baud rate.\r
  *\r
  * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- * @param baud_rate UART baud-rate.\r
+ * @param baudrate UART baud rate.\r
  *\r
  * @return\r
  *     - ESP_FAIL Parameter error\r
  *     - ESP_OK   Success\r
  */\r
-esp_err_t uart_set_baudrate(uart_port_t uart_num, uint32_t baud_rate);\r
+esp_err_t uart_set_baudrate(uart_port_t uart_num, uint32_t baudrate);\r
 \r
 /**\r
  * @brief Get UART bit-rate.\r
@@ -241,7 +241,7 @@ esp_err_t uart_get_baudrate(uart_port_t uart_num, uint32_t* baudrate);
  * @brief Set UART line inverse mode\r
  *\r
  * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- * @param inverse_mask Choose the wires that need to be inversed.\r
+ * @param inverse_mask Choose the wires that need to be inverted.\r
  *        Inverse_mask should be chosen from UART_INVERSE_RXD/UART_INVERSE_TXD/UART_INVERSE_RTS/UART_INVERSE_CTS, combine with OR operation.\r
  *\r
  * @return\r