espressif/ESP8266_RTOS_SDK
1
0
Fork 0
mirror of https://github.com/espressif/ESP8266_RTOS_SDK.git synced 2025-10-20 13:45:08 +08:00
Code Issues Projects Releases Wiki Activity

docs(doxygen): Fix header files which is not doxygen style

Browse Source
This commit is contained in:
dongheng
2019-05-16 13:43:11 +08:00
parent 209ffcfaa6
commit 2a0b0f601b
12 changed files with 152 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/esp8266/include/driver/adc.h
View File

@@ -34,8 +34,8 @@ typedef enum {
* @brief ADC initialization parameter structure type definition
*/
typedef struct {
adc_mode_t mode;
uint8_t clk_div; // ADC sample collection clock=80M/clk_div, range[8, 32]
adc_mode_t mode; /*!< ADC mode */
uint8_t clk_div; /*!< ADC sample collection clock=80M/clk_div, range[8, 32] */
} adc_config_t;
/**

2
components/esp8266/include/driver/gpio.h
View File

@@ -133,7 +133,7 @@ typedef void *gpio_isr_handle_t;
*
* Configure GPIO's Mode,pull-up,PullDown,IntrType
*
* @param gpio_config Pointer to GPIO configure struct
* @param gpio_cfg Pointer to GPIO configure struct
*
* @return
* - ESP_OK success

52
components/esp8266/include/driver/spi.h
View File

@@ -105,14 +105,14 @@ typedef enum {
*/
typedef union {
struct {
uint32_t read_buffer: 1;
uint32_t write_buffer: 1;
uint32_t read_status: 1;
uint32_t write_status: 1;
uint32_t trans_done: 1;
uint32_t reserved5: 27;
};
uint32_t val;
uint32_t read_buffer: 1; /*!< configurate intterrupt to enable reading */
uint32_t write_buffer: 1; /*!< configurate intterrupt to enable writing */
uint32_t read_status: 1; /*!< configurate intterrupt to enable reading status */
uint32_t write_status: 1; /*!< configurate intterrupt to enable writing status */
uint32_t trans_done: 1; /*!< configurate intterrupt to enable transmission done */
uint32_t reserved5: 27; /*!< reserved */
}; /*!< not filled */
uint32_t val; /*!< union fill */
} spi_intr_enable_t;
/**
@@ -130,38 +130,38 @@ typedef union {
uint32_t miso_en: 1; /*!< MISO line enable */
uint32_t cs_en: 1; /*!< CS line enable */
uint32_t reserved9: 23; /*!< resserved */
};
uint32_t val;
}; /*!< not filled */
uint32_t val; /*!< union fill */
} spi_interface_t;
/**
* @brief SPI transmission parameter structure type definition
*/
typedef struct {
uint16_t *cmd;
uint32_t *addr;
uint32_t *mosi;
uint32_t *miso;
uint16_t *cmd; /*!< SPI transmission command */
uint32_t *addr; /*!< SPI transmission address */
uint32_t *mosi; /*!< SPI transmission MOSI buffer */
uint32_t *miso; /*!< SPI transmission MISO buffer */
union {
struct {
uint32_t cmd: 5;
uint32_t addr: 7;
uint32_t mosi: 10;
uint32_t miso: 10;
};
uint32_t val;
} bits;
uint32_t cmd: 5; /*!< SPI transmission command bits */
uint32_t addr: 7; /*!< SPI transmission address bits */
uint32_t mosi: 10; /*!< SPI transmission MOSI buffer bits */
uint32_t miso: 10; /*!< SPI transmission MISO buffer bits */
}; /*!< not filled */
uint32_t val; /*!< union fill */
} bits; /*!< SPI transmission packet members' bits */
} spi_trans_t;
/**
* @brief SPI initialization parameter structure type definition
*/
typedef struct {
spi_interface_t interface;
spi_intr_enable_t intr_enable;
spi_event_callback_t event_cb;
spi_mode_t mode;
spi_clk_div_t clk_div;
spi_interface_t interface; /*!< SPI bus interface */
spi_intr_enable_t intr_enable; /*!< check if enable SPI interrupt */
spi_event_callback_t event_cb; /*!< SPI interrupt event callback */
spi_mode_t mode; /*!< SPI mode */
spi_clk_div_t clk_div; /*!< SPI clock divider */
} spi_config_t;
/**