Bläddra i källkod

driver: Fix some doxygen warnings

Angus Gratton 5 år sedan
förälder
incheckning
8193b188e8
2 ändrade filer med 3 tillägg och 4 borttagningar
  1. 0 1
      components/driver/include/driver/uart.h
  2. 3 3
      components/soc/include/hal/adc_types.h

+ 0 - 1
components/driver/include/driver/uart.h

@@ -858,7 +858,6 @@ esp_err_t uart_set_loop_back(uart_port_t uart_num, bool loop_back_en);
   * @param always_rx_timeout_en Set to false enable the default behavior of timeout interrupt,
   *                             set it to true to always trigger timeout interrupt.
   *
-  * * @return None
   */
 void uart_set_always_rx_timeout(uart_port_t uart_num, bool always_rx_timeout_en);
 

+ 3 - 3
components/soc/include/hal/adc_types.h

@@ -108,7 +108,7 @@ typedef struct {
                                         If (channel > ADC_CHANNEL_MAX), The data is invalid. */
             uint16_t unit:      1;  /*!<ADC unit index info. 0: ADC1; 1: ADC2.  */
         } type2;                    /*!<When the configured output format is 11bit. `ADC_DIGI_FORMAT_11BIT` */
-        uint16_t val;
+        uint16_t val;               /*!<Raw data value */
     };
 } adc_digi_output_data_t;
 
@@ -191,10 +191,10 @@ typedef struct {
                                          1: input voltage * 1/1.34;
                                          2: input voltage * 1/2;
                                          3: input voltage * 1/3.6. */
-            uint8_t reserved:  2;    /*!< reserved0 */
+            uint8_t reserved:  2;   /*!< reserved0 */
             uint8_t channel:   4;   /*!< ADC channel index. */
         };
-        uint8_t val;
+        uint8_t val;                /*!< Raw entry value */
     };
 } adc_digi_pattern_table_t;