driver: fix header file warnings for Doxygen.

diff --git a/components/driver/include/driver/gpio.h b/components/driver/include/driver/gpio.h
index 73efeaa3421e2b1e962ce0e333b5996673ad0ba6..2d92dc50a99870e8d2dda875f8158e1ea65ec9ba 100644 (file)
--- a/components/driver/include/driver/gpio.h
+++ b/components/driver/include/driver/gpio.h
@@ -314,7 +314,7 @@ esp_err_t gpio_set_pull_mode(gpio_num_t gpio_num, gpio_pull_mode_t pull);
   *
   * @param gpio_num GPIO number.
   *
-  * @param intr_type GPIO wake-up type. Only GPIO_INTR_LOW_LEVEL\GPIO_INTR_HIGH_LEVEL can be used.
+  * @param intr_type GPIO wake-up type. Only GPIO_INTR_LOW_LEVEL or GPIO_INTR_HIGH_LEVEL can be used.
   *
   * @return
   *     - ESP_OK Success

diff --git a/components/driver/include/driver/ledc.h b/components/driver/include/driver/ledc.h
index 3ab0ebff1e583afae83b7ef6d035c222de7fc3f8..317a599fbc96afa0662e863ea4a3966d82541ef4 100644 (file)
--- a/components/driver/include/driver/ledc.h
+++ b/components/driver/include/driver/ledc.h
@@ -150,6 +150,8 @@ esp_err_t ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel);
  *
  * @param  channel LEDC channel(0-7), select from ledc_channel_t
  *
+ * @param  idle_level Set output idle level after LEDC stops.
+ *
  * @return
  *     - ESP_OK Success
  *     - ESP_ERR_INVALID_ARG Parameter error

diff --git a/components/driver/include/driver/uart.h b/components/driver/include/driver/uart.h
index 906bdcb9e9193034b894115c25116caa69174ca1..687ae71aad8ed622eb3917d224dd606eff46b8c9 100644 (file)
--- a/components/driver/include/driver/uart.h
+++ b/components/driver/include/driver/uart.h
@@ -113,11 +113,11 @@ typedef struct {
 } uart_event_t;\r
 \r
 /**\r
- * @brief   Set UART data bits.\r
+ * @brief Set UART data bits.\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   data_bit UART data bits\r
+ * @param data_bit UART data bits\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -126,9 +126,11 @@ typedef struct {
 esp_err_t uart_set_word_length(uart_port_t uart_num, uart_word_length_t data_bit);\r
 \r
 /**\r
- * @brief   Get UART data bits.\r
+ * @brief Get UART data bits.\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ *\r
+ * @param data_bit Pointer to accept value of UART data bits.\r
  *\r
  * @return\r
  *     - ESP_FAIL  Parameter error\r
@@ -137,22 +139,24 @@ esp_err_t uart_set_word_length(uart_port_t uart_num, uart_word_length_t data_bit
 esp_err_t uart_get_word_length(uart_port_t uart_num, uart_word_length_t* data_bit);\r
 \r
 /**\r
- * @brief   Set UART stop bits.\r
+ * @brief Set UART stop bits.\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   bit_num  UART stop bits\r
+ * @param bit_num  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_no, uart_stop_bits_t bit_num);\r
+esp_err_t uart_set_stop_bits(uart_port_t uart_num, uart_stop_bits_t bit_num);\r
 \r
 /**\r
- * @brief   Set UART stop bits.\r
+ * @brief Set UART stop bits.\r
+ *\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param stop_bit  Pointer to accept value of UART stop bits.\r
  *\r
  * @return\r
  *     - ESP_FAIL Parameter error\r
@@ -161,22 +165,24 @@ esp_err_t uart_set_stop_bits(uart_port_t uart_no, uart_stop_bits_t bit_num);
 esp_err_t uart_get_stop_bits(uart_port_t uart_num, uart_stop_bits_t* stop_bit);\r
 \r
 /**\r
- * @brief   Set UART parity.\r
+ * @brief Set UART parity.\r
  *\r
- * @param   uart_no     UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   parity_mode the enum of uart parity configuration\r
+ * @param parity_mode the enum of uart parity configuration\r
  *\r
  * @return\r
  *     - ESP_FAIL  Parameter error\r
  *     - ESP_OK    Success\r
  */\r
-esp_err_t uart_set_parity(uart_port_t uart_no, uart_parity_t parity_mode);\r
+esp_err_t uart_set_parity(uart_port_t uart_num, uart_parity_t parity_mode);\r
 \r
 /**\r
- * @brief   Get UART parity mode.\r
+ * @brief Get UART parity mode.\r
+ *\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param parity_mode Pointer to accept value of UART parity mode.\r
  *\r
  * @return\r
  *     - ESP_FAIL  Parameter error\r
@@ -186,22 +192,24 @@ esp_err_t uart_set_parity(uart_port_t uart_no, uart_parity_t parity_mode);
 esp_err_t uart_get_parity(uart_port_t uart_num, uart_parity_t* parity_mode);\r
 \r
 /**\r
- * @brief   Set UART baud rate.\r
+ * @brief Set UART baud rate.\r
  *\r
- * @param   uart_no   UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   baud_rate UART baud-rate.\r
+ * @param baud_rate 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_no, uint32_t baud_rate);\r
+esp_err_t uart_set_baudrate(uart_port_t uart_num, uint32_t baud_rate);\r
 \r
 /**\r
- * @brief   Get UART bit-rate.\r
+ * @brief Get UART bit-rate.\r
  *\r
- * @param   uart_no: UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ *\r
+ * @param baudrate Pointer to accept value of UART baud rate\r
  *\r
  * @return\r
  *     - ESP_FAIL Parameter error\r
@@ -211,11 +219,11 @@ esp_err_t uart_set_baudrate(uart_port_t uart_no, uint32_t baud_rate);
 esp_err_t uart_get_baudrate(uart_port_t uart_num, uint32_t* baudrate);\r
 \r
 /**\r
- * @brief   Set UART line inverse mode\r
+ * @brief Set UART line inverse mode\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   inverse_mask Choose the wires that need to be inversed.\r
+ * @param Inverse_mask Choose the wires that need to be inversed.\r
  *\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
@@ -223,16 +231,16 @@ esp_err_t uart_get_baudrate(uart_port_t uart_num, uint32_t* baudrate);
  *     - ESP_OK   Success\r
  *     - ESP_FAIL Parameter error\r
  */\r
-esp_err_t uart_set_line_inverse(uart_port_t uart_no, uint32_t inverse_mask);\r
+esp_err_t uart_set_line_inverse(uart_port_t uart_num, uint32_t inverse_mask);\r
 \r
 /**\r
- * @brief   Set hardware flow control.\r
+ * @brief Set hardware flow control.\r
  *\r
- * @param   uart_no   UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num   UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   flow_ctrl Hardware flow control mode\r
+ * @param flow_ctrl Hardware flow control mode\r
  *\r
- * @param   rx_thresh Threshold of Hardware RX flow control(0 ~ UART_FIFO_LEN)\r
+ * @param rx_thresh Threshold of Hardware RX flow control(0 ~ UART_FIFO_LEN)\r
  *\r
  *          Only when UART_HW_FLOWCTRL_RTS is set , will the rx_thresh value be set.\r
  *\r
@@ -240,12 +248,14 @@ esp_err_t uart_set_line_inverse(uart_port_t uart_no, uint32_t inverse_mask);
  *     - ESP_OK   Success\r
  *     - ESP_FAIL Parameter error\r
  */\r
-esp_err_t uart_set_hw_flow_ctrl(uart_port_t uart_no, uart_hw_flowcontrol_t flow_ctrl, uint8_t rx_thresh);\r
+esp_err_t uart_set_hw_flow_ctrl(uart_port_t uart_num, uart_hw_flowcontrol_t flow_ctrl, uint8_t rx_thresh);\r
 \r
 /**\r
- * @brief   Get hardware flow control mode\r
+ * @brief Get hardware flow control mode\r
+ *\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param flow_ctrl Option for different flow control mode.\r
  *\r
  * @return\r
  *     - ESP_FAIL Parameter error\r
@@ -254,11 +264,11 @@ esp_err_t uart_set_hw_flow_ctrl(uart_port_t uart_no, uart_hw_flowcontrol_t flow_
 esp_err_t uart_get_hw_flow_ctrl(uart_port_t uart_num, uart_hw_flowcontrol_t* flow_ctrl);\r
 \r
 /**\r
- * @brief   Clear UART interrupt status\r
+ * @brief Clear UART interrupt status\r
  *\r
- * @param   uart_no   UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num   UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   clr_mask  Bit mask of the status that to be cleared.\r
+ * @param clr_mask  Bit mask of the status that to be cleared.\r
  *\r
  *                    (enable_mask should be chosen from the fields of register UART_INT_CLR_REG)\r
  *\r
@@ -269,11 +279,11 @@ esp_err_t uart_get_hw_flow_ctrl(uart_port_t uart_num, uart_hw_flowcontrol_t* flo
 esp_err_t uart_clear_intr_status(uart_port_t uart_num, uint32_t clr_mask);\r
 \r
 /**\r
- * @brief   Set UART interrupt enable\r
+ * @brief Set UART interrupt enable\r
  *\r
- * @param   uart_no      UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num      UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   enable_mask  Bit mask of the enable bits.\r
+ * @param enable_mask  Bit mask of the enable bits.\r
  *\r
  *                       (enable_mask should be chosen from the fields of register UART_INT_ENA_REG)\r
  *\r
@@ -284,11 +294,11 @@ esp_err_t uart_clear_intr_status(uart_port_t uart_num, uint32_t clr_mask);
 esp_err_t uart_enable_intr_mask(uart_port_t uart_num, uint32_t enable_mask);\r
 \r
 /**\r
- * @brief   Clear UART interrupt enable bits\r
+ * @brief Clear UART interrupt enable bits\r
  *\r
- * @param   uart_no       UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num       UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   disable_mask  Bit mask of the disable bits.\r
+ * @param disable_mask  Bit mask of the disable bits.\r
  *\r
  *                        (disable_mask should be chosen from the fields of register UART_INT_ENA_REG)\r
  *\r
@@ -300,9 +310,9 @@ esp_err_t uart_disable_intr_mask(uart_port_t uart_num, uint32_t disable_mask);
 \r
 \r
 /**\r
- * @brief   Enable UART RX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
+ * @brief Enable UART RX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -311,9 +321,9 @@ esp_err_t uart_disable_intr_mask(uart_port_t uart_num, uint32_t disable_mask);
 esp_err_t uart_enable_rx_intr(uart_port_t uart_num);\r
 \r
 /**\r
- * @brief   Disable UART RX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
+ * @brief Disable UART RX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -322,9 +332,9 @@ esp_err_t uart_enable_rx_intr(uart_port_t uart_num);
 esp_err_t uart_disable_rx_intr(uart_port_t uart_num);\r
 \r
 /**\r
- * @brief   Disable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
+ * @brief Disable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -333,13 +343,13 @@ esp_err_t uart_disable_rx_intr(uart_port_t uart_num);
 esp_err_t uart_disable_tx_intr(uart_port_t uart_num);\r
 \r
 /**\r
- * @brief   Enable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
+ * @brief Enable UART TX interrupt(RX_FULL & RX_TIMEOUT INTERRUPT)\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   enable  1: enable; 0: disable\r
+ * @param enable  1: enable; 0: disable\r
  *\r
- * @param   thresh  Threshold of TX interrupt, 0 ~ UART_FIFO_LEN\r
+ * @param thresh  Threshold of TX interrupt, 0 ~ UART_FIFO_LEN\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -348,21 +358,20 @@ esp_err_t uart_disable_tx_intr(uart_port_t uart_num);
 esp_err_t uart_enable_tx_intr(uart_port_t uart_num, int enable, int thresh);\r
 \r
 /**\r
-* @brief   register UART interrupt handler(ISR).\r
+* @brief register UART interrupt handler(ISR).\r
 *           @note\r
  *          UART ISR handler will be attached to the same CPU core that this function is running on.\r
  *          Users should know that which CPU is running and then pick a INUM that is not used by system.\r
  *          We can find the information of INUM and interrupt level in soc.h.\r
  *\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details\r
  *\r
- * @param   uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details\r
- *\r
- * @param   fn  Interrupt handler function.\r
+ * @param fn  Interrupt handler function.\r
  * @attention\r
  *          The ISR handler function MUST be defined with attribution of "IRAM_ATTR" for now.\r
- * @param   arg parameter for handler function\r
+ * @param arg parameter for handler function\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -371,21 +380,21 @@ esp_err_t uart_enable_tx_intr(uart_port_t uart_num, int enable, int thresh);
 esp_err_t uart_isr_register(uart_port_t uart_num, uint8_t uart_intr_num, void (*fn)(void*), void * arg);\r
 \r
 /**\r
- * @brief   Set UART pin number\r
+ * @brief Set UART pin number\r
  *\r
  *          @note\r
  *          Internal signal can be output to multiple GPIO pads\r
  *          Only one GPIO pad can connect with input signal\r
  *\r
- * @param   uart_no    UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num    UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   tx_io_num  UART TX pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
+ * @param tx_io_num  UART TX pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
  *\r
- * @param   rx_io_num  UART RX pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
+ * @param rx_io_num  UART RX pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
  *\r
- * @param   rts_io_num UART RTS pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
+ * @param rts_io_num UART RTS pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
  *\r
- * @param   cts_io_num UART CTS pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
+ * @param cts_io_num UART CTS pin GPIO number, if set to UART_PIN_NO_CHANGE, use the current pin.\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -394,12 +403,12 @@ esp_err_t uart_isr_register(uart_port_t uart_num, uint8_t uart_intr_num, void (*
 esp_err_t uart_set_pin(uart_port_t uart_num, int tx_io_num, int rx_io_num, int rts_io_num, int cts_io_num);\r
 \r
 /**\r
- * @brief   UART set RTS level (before inverse)\r
+ * @brief UART set RTS level (before inverse)\r
  *          UART rx hardware flow control should not be set.\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   level   1: RTS output low(active); 0: RTS output high(block)\r
+ * @param level   1: RTS output low(active); 0: RTS output high(block)\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -408,11 +417,11 @@ esp_err_t uart_set_pin(uart_port_t uart_num, int tx_io_num, int rx_io_num, int r
 esp_err_t uart_set_rts(uart_port_t uart_num, int level);\r
 \r
 /**\r
- * @brief   UART set DTR level (before inverse)\r
+ * @brief UART set DTR level (before inverse)\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   level    1: DTR output low; 0: DTR output high\r
+ * @param level    1: DTR output low; 0: DTR output high\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -421,11 +430,11 @@ esp_err_t uart_set_rts(uart_port_t uart_num, int level);
 esp_err_t uart_set_dtr(uart_port_t uart_num, int level);\r
 \r
 /**\r
-* @brief   UART parameter configure\r
+* @brief UART parameter configure\r
  *\r
- * @param   uart_no     UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num     UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   uart_config UART parameter settings\r
+ * @param uart_config UART parameter settings\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -434,11 +443,11 @@ esp_err_t uart_set_dtr(uart_port_t uart_num, int level);
 esp_err_t uart_param_config(uart_port_t uart_num, const uart_config_t *uart_config);\r
 \r
 /**\r
-* @brief   UART interrupt configure\r
+* @brief UART interrupt configure\r
  *\r
- * @param   uart_no     UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num     UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   intr_conf UART interrupt settings\r
+ * @param intr_conf UART interrupt settings\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -447,25 +456,25 @@ esp_err_t uart_param_config(uart_port_t uart_num, const uart_config_t *uart_conf
 esp_err_t uart_intr_config(uart_port_t uart_num, const uart_intr_config_t *intr_conf);\r
 \r
 /**\r
- * @brief   Install UART driver.\r
+ * @brief Install UART driver.\r
  *\r
  *          UART ISR handler will be attached to the same CPU core that this function is running on.\r
  *          Users should know that which CPU is running and then pick a INUM that is not used by system.\r
  *          We can find the information of INUM and interrupt level in soc.h.\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   rx_buffer_size UART RX ring buffer size\r
+ * @param rx_buffer_size UART RX ring buffer size\r
  *\r
- * @param   tx_buffer_size UART TX ring buffer size.\r
+ * @param tx_buffer_size UART TX ring buffer size.\r
  *\r
  *          If set to zero, driver will not use TX buffer, TX function will block task until all data have been sent out..\r
  *\r
- * @param   queue_size UART event queue size/depth.\r
+ * @param queue_size UART event queue size/depth.\r
  *\r
- * @param   uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details\r
+ * @param uart_intr_num UART interrupt number,check the info in soc.h, and please refer to core-isa.h for more details\r
  *\r
- * @param   uart_queue UART event queue handle, if set NULL, driver will not use an event queue.\r
+ * @param uart_queue UART event queue handle, if set NULL, driver will not use an event queue.\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -474,9 +483,9 @@ esp_err_t uart_intr_config(uart_port_t uart_num, const uart_intr_config_t *intr_
 esp_err_t uart_driver_install(uart_port_t uart_num, int rx_buffer_size, int tx_buffer_size, int queue_size, int uart_intr_num, void* uart_queue);\r
 \r
 /**\r
- * @brief   Uninstall UART driver.\r
+ * @brief Uninstall UART driver.\r
  *\r
- * @param   uart_no  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num  UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -485,11 +494,11 @@ esp_err_t uart_driver_install(uart_port_t uart_num, int rx_buffer_size, int tx_b
 esp_err_t uart_driver_delete(uart_port_t uart_num);\r
 \r
 /**\r
- * @brief   Wait UART TX FIFO empty\r
+ * @brief Wait UART TX FIFO empty\r
  *\r
- * @param   uart_no       UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num       UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   ticks_to_wait Timeout, count in RTOS ticks\r
+ * @param ticks_to_wait Timeout, count in RTOS ticks\r
  *\r
  * @return\r
  *     - ESP_OK   Success\r
@@ -499,26 +508,25 @@ esp_err_t uart_driver_delete(uart_port_t uart_num);
 esp_err_t uart_wait_tx_done(uart_port_t uart_num, TickType_t ticks_to_wait);\r
 \r
 /**\r
- * @brief   Send data to the UART port from a given buffer and length,\r
+ * @brief Send data to the UART port from a given buffer and length,\r
  *          This function will not wait for the space in TX FIFO, just fill the TX FIFO and return when the FIFO is full.\r
  *          @note\r
  *          This function should only be used when UART TX buffer is not enabled.\r
  *\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
- * @param   buffer data buffer address\r
+ * @param buffer data buffer address\r
  *\r
- * @param   len    data length to send\r
+ * @param len    data length to send\r
  *\r
  * @return\r
  *     - (-1)  Parameter error\r
  *     - OTHERS(>=0)  The number of data that pushed to the TX FIFO\r
  */\r
-int uart_tx_chars(uart_port_t uart_no, const char* buffer, uint32_t len);\r
+int uart_tx_chars(uart_port_t uart_num, const char* buffer, uint32_t len);\r
 \r
 /**\r
- * @brief   Send data to the UART port from a given buffer and length,\r
+ * @brief Send data to the UART port from a given buffer and length,\r
  *\r
  *          If parameter tx_buffer_size is set to zero:\r
  *          This function will not return until all the data have been sent out, or at least pushed into TX FIFO.\r
@@ -526,11 +534,11 @@ int uart_tx_chars(uart_port_t uart_no, const char* buffer, uint32_t len);
  *          Otherwise, if tx_buffer_size > 0, this function will return after copying all the data to tx ringbuffer,\r
  *          then, UART ISR will move data from ring buffer to TX FIFO gradually.\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   src   data buffer address\r
+ * @param src   data buffer address\r
  *\r
- * @param   size  data length to send\r
+ * @param size  data length to send\r
  *\r
  * @return\r
  *     - (-1) Parameter error\r
@@ -539,7 +547,7 @@ int uart_tx_chars(uart_port_t uart_no, const char* buffer, uint32_t len);
 int uart_write_bytes(uart_port_t uart_num, const char* src, size_t size);\r
 \r
 /**\r
- * @brief   Send data to the UART port from a given buffer and length,\r
+ * @brief Send data to the UART port from a given buffer and length,\r
  *\r
  *          If parameter tx_buffer_size is set to zero:\r
  *          This function will not return until all the data and the break signal have been sent out.\r
@@ -549,15 +557,13 @@ int uart_write_bytes(uart_port_t uart_num, const char* src, size_t size);
  *          then, UART ISR will move data from ring buffer to TX FIFO gradually.\r
  *          After all data send out, send a break signal.\r
  *\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
+ * @param src   data buffer address\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
- *\r
- * @param   src   data buffer address\r
+ * @param size  data length to send\r
  *\r
- * @param   size  data length to send\r
- *\r
- * @param   brk_len break signal length (unit: one bit's time@current_baudrate)\r
+ * @param brk_len break signal length (unit: time of one data bit at current_baudrate)\r
  *\r
  * @return\r
  *     - (-1) Parameter error\r
@@ -567,16 +573,15 @@ int uart_write_bytes(uart_port_t uart_num, const char* src, size_t size);
 int uart_write_bytes_with_break(uart_port_t uart_num, const char* src, size_t size, int brk_len);\r
 \r
 /**\r
-* @brief   UART read bytes from UART buffer\r
- *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @brief UART read bytes from UART buffer\r
  *\r
- * @param   buf     pointer to the buffer.\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
- * @param   length  data length\r
+ * @param buf     pointer to the buffer.\r
  *\r
- * @param   ticks_to_wait sTimeout, count in RTOS ticks\r
+ * @param length  data length\r
  *\r
+ * @param ticks_to_wait sTimeout, count in RTOS ticks\r
  *\r
  * @return\r
  *     - (-1) Error\r
@@ -585,9 +590,9 @@ 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);\r
 \r
 /**\r
- * @brief   UART ring buffer flush\r
+ * @brief UART ring buffer flush\r
  *\r
- * @param   uart_no UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
+ * @param uart_num UART_NUM_0, UART_NUM_1 or UART_NUM_2\r
  *\r
  * @return\r
  *     - ESP_OK Success\r