From 9d19f4fc8e773e6dccf6d6f635c67a507f4135cc Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Fri, 13 Sep 2019 14:04:38 +1000 Subject: [PATCH] driver docs: Fix some doxygen warnings --- components/driver/esp32s2beta/include/temp_sensor.h | 5 ++++- components/driver/include/driver/i2c.h | 4 ++-- components/driver/include/driver/ledc.h | 1 - components/driver/include/driver/mcpwm.h | 1 - docs/en/api-reference/peripherals/temp_sensor.rst | 2 +- 5 files changed, 7 insertions(+), 6 deletions(-) diff --git a/components/driver/esp32s2beta/include/temp_sensor.h b/components/driver/esp32s2beta/include/temp_sensor.h index 66142824c5..09d2a6c5f3 100644 --- a/components/driver/esp32s2beta/include/temp_sensor.h +++ b/components/driver/esp32s2beta/include/temp_sensor.h @@ -31,6 +31,9 @@ typedef enum { TSENS_DAC_DEFAULT = TSENS_DAC_L2, } temp_sensor_dac_offset_t; +/** + * @brief Configuration for temperature sensor reading + */ typedef struct { temp_sensor_dac_offset_t dac_offset; /*!< The temperature measurement range is configured with a built-in temperature offset DAC. */ uint8_t clk_div; /*!< Default: 6 */ @@ -93,4 +96,4 @@ esp_err_t temp_sensor_read_celsius(float *celsius); #ifdef __cplusplus } -#endif \ No newline at end of file +#endif diff --git a/components/driver/include/driver/i2c.h b/components/driver/include/driver/i2c.h index eaa902e612..fafbc7b968 100644 --- a/components/driver/include/driver/i2c.h +++ b/components/driver/include/driver/i2c.h @@ -89,11 +89,11 @@ typedef struct{ union { struct { uint32_t clk_speed; /*!< I2C clock frequency for master mode, (no higher than 1MHz for now) */ - } master; + } master; /*!< Configuration if the I2C peripheral is master */ struct { uint8_t addr_10bit_en; /*!< I2C 10bit address mode enable for slave mode */ uint16_t slave_addr; /*!< I2C address for slave mode */ - } slave; + } slave; /*!< Configuration if the I2C peripheral is slave */ }; }i2c_config_t; diff --git a/components/driver/include/driver/ledc.h b/components/driver/include/driver/ledc.h index bb7e577547..c801b8cc9c 100644 --- a/components/driver/include/driver/ledc.h +++ b/components/driver/include/driver/ledc.h @@ -314,7 +314,6 @@ esp_err_t ledc_set_fade(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t * @param arg User-supplied argument passed to the handler function. * @param intr_alloc_flags Flags used to allocate the interrupt. One or multiple (ORred) * ESP_INTR_FLAG_* values. See esp_intr_alloc.h for more info. - * @param arg Parameter for handler function * @param handle Pointer to return handle. If non-NULL, a handle for the interrupt will * be returned here. * diff --git a/components/driver/include/driver/mcpwm.h b/components/driver/include/driver/mcpwm.h index ea85a83d44..4d29cfb966 100644 --- a/components/driver/include/driver/mcpwm.h +++ b/components/driver/include/driver/mcpwm.h @@ -696,7 +696,6 @@ esp_err_t mcpwm_sync_disable(mcpwm_unit_t mcpwm_num, mcpwm_timer_t timer_num); * @param arg user-supplied argument passed to the handler function. * @param intr_alloc_flags flags used to allocate the interrupt. One or multiple (ORred) * ESP_INTR_FLAG_* values. see esp_intr_alloc.h for more info. - * @param arg parameter for handler function * @param handle pointer to return handle. If non-NULL, a handle for the interrupt will * be returned here. * diff --git a/docs/en/api-reference/peripherals/temp_sensor.rst b/docs/en/api-reference/peripherals/temp_sensor.rst index b246ac8f2d..b9dd6a2d9a 100644 --- a/docs/en/api-reference/peripherals/temp_sensor.rst +++ b/docs/en/api-reference/peripherals/temp_sensor.rst @@ -1,5 +1,5 @@ ESP32-S2 Temperature Sensor -================== +=========================== Overview --------