driver docs: Fix some doxygen warnings

pull/4273/head
Angus Gratton 2019-09-13 14:04:38 +10:00 zatwierdzone przez Angus Gratton
rodzic 49698e15f3
commit 9d19f4fc8e
5 zmienionych plików z 7 dodań i 6 usunięć

Wyświetl plik

@ -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
#endif

Wyświetl plik

@ -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;

Wyświetl plik

@ -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.
*

Wyświetl plik

@ -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.
*

Wyświetl plik

@ -1,5 +1,5 @@
ESP32-S2 Temperature Sensor
==================
===========================
Overview
--------