Skip to content

Commit

Permalink
docs(doxygen): Fix header files which is not doxygen style
Browse files Browse the repository at this point in the history
  • Loading branch information
dongheng authored and dongheng committed May 16, 2019
1 parent 209ffcf commit 2a0b0f6
Show file tree
Hide file tree
Showing 12 changed files with 152 additions and 152 deletions.
4 changes: 2 additions & 2 deletions components/esp8266/include/driver/adc.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
Expand Down
2 changes: 1 addition & 1 deletion components/esp8266/include/driver/gpio.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
52 changes: 26 additions & 26 deletions components/esp8266/include/driver/spi.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
Expand All @@ -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;

/**
Expand Down
102 changes: 29 additions & 73 deletions components/esp8266/include/esp_sleep.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
extern "C" {
#endif

/** \defgroup System_Sleep_APIs System Sleep APIs
* @brief System Sleep APIs
*/
typedef enum {
WIFI_NONE_SLEEP_T = 0,
WIFI_LIGHT_SLEEP_T,
WIFI_MODEM_SLEEP_T
} wifi_sleep_type_t;

/** @addtogroup System_Sleep_APIs
* @{
*/
typedef void (*fpm_wakeup_cb)(void);

/**
* @brief Set the chip to deep-sleep mode.
Expand All @@ -40,7 +40,7 @@ extern "C" {
* up, connect a GPIO to pin RST, the chip will wake up by a falling-edge
* on pin RST
*
* @param uint32 time_in_us : deep-sleep time, unit: microsecond
* @param time_in_us deep-sleep time, unit: microsecond
*
* @return null
*/
Expand All @@ -53,64 +53,33 @@ void esp_deep_sleep(uint32_t time_in_us);
*
* If this API is not called, default to be esp_deep_sleep_set_rf_option(1).
*
* @param uint8 option :
* @param 0 : Radio calibration after the deep-sleep wakeup is decided by byte
* 108 of esp_init_data_default.bin (0~127byte).
* @param 1 : Radio calibration will be done after the deep-sleep wakeup. This
* will lead to stronger current.
* @param 2 : Radio calibration will not be done after the deep-sleep wakeup.
* This will lead to weaker current.
* @param 4 : Disable radio calibration after the deep-sleep wakeup (the same
* as modem-sleep). This will lead to the weakest current, but the device
* can't receive or transmit data after waking up.
* @param option radio option
* 0 : Radio calibration after the deep-sleep wakeup is decided by byte
* 108 of esp_init_data_default.bin (0~127byte).
* 1 : Radio calibration will be done after the deep-sleep wakeup. This
* will lead to stronger current.
* 2 : Radio calibration will not be done after the deep-sleep wakeup.
* This will lead to weaker current.
* 4 : Disable radio calibration after the deep-sleep wakeup (the same
* as modem-sleep). This will lead to the weakest current, but the device
* can't receive or transmit data after waking up.
*
* @return null
*/
void esp_deep_sleep_set_rf_option(uint8_t option);

/** \defgroup WiFi_Sleep_Type_APIs Sleep Type APIs
* @brief WiFi Sleep APIs
*/

/** @addtogroup WiFi_Sleep_Type_APIs
* @{
*/

typedef enum {
WIFI_NONE_SLEEP_T = 0,
WIFI_LIGHT_SLEEP_T,
WIFI_MODEM_SLEEP_T
} wifi_sleep_type_t;

/**
* @}
*/


/** \defgroup WiFi_Force_Sleep_APIs Force Sleep APIs
* @brief WiFi Force Sleep APIs
*/

/** @addtogroup WiFi_Force_Sleep_APIs
* @{
*/

/**
* @brief Enable force sleep function.
*
* @attention Force sleep function is disabled by default.
*
* @param null
*
* @return null
*/
void esp_wifi_fpm_open(void);

/**
* @brief Disable force sleep function.
*
* @param null
*
* @return null
*/
void esp_wifi_fpm_close(void);
Expand All @@ -122,14 +91,10 @@ void esp_wifi_fpm_close(void);
* is enabled, after calling wifi_fpm_open.
* This API can not be called after calling wifi_fpm_close.
*
* @param null
*
* @return null
*/
void esp_wifi_fpm_do_wakeup(void);

typedef void (*fpm_wakeup_cb)(void);

/**
* @brief Set a callback of waken up from force sleep because of time out.
*
Expand All @@ -141,7 +106,7 @@ typedef void (*fpm_wakeup_cb)(void);
* @attention 3. fpm_wakeup_cb_func will not be called if woke up by wifi_fpm_do_wakeup
* from MODEM_SLEEP_T type force sleep.
*
* @param void (*fpm_wakeup_cb_func)(void) : callback of waken up
* @param cb callback of waken up
*
* @return null
*/
Expand All @@ -157,11 +122,11 @@ void esp_wifi_fpm_set_wakeup_cb(fpm_wakeup_cb cb);
* in the system idle task. Please do not call other WiFi related function right
* after calling this API.
*
* @param uint32 sleep_time_in_us : sleep time, ESP8266 will wake up automatically
* when time out. Unit: us. Range: 10000 ~ 268435455(0xFFFFFFF).
* - If sleep_time_in_us is 0xFFFFFFF, the ESP8266 will sleep till
* - if wifi_fpm_set_sleep_type is set to be LIGHT_SLEEP_T, ESP8266 can wake up by GPIO.
* - if wifi_fpm_set_sleep_type is set to be MODEM_SLEEP_T, ESP8266 can wake up by wifi_fpm_do_wakeup.
* @param sleep_time_in_us sleep time, ESP8266 will wake up automatically
* when time out. Unit: us. Range: 10000 ~ 268435455(0xFFFFFFF).
* - If sleep_time_in_us is 0xFFFFFFF, the ESP8266 will sleep till
* - if wifi_fpm_set_sleep_type is set to be LIGHT_SLEEP_T, ESP8266 can wake up by GPIO.
* - if wifi_fpm_set_sleep_type is set to be MODEM_SLEEP_T, ESP8266 can wake up by wifi_fpm_do_wakeup.
*
* @return ESP_OK, setting succeed;
* @return ESP_ERR_WIFI_FPM_MODE, fail to sleep, force sleep function is not enabled.
Expand All @@ -175,7 +140,7 @@ esp_err_t esp_wifi_fpm_do_sleep(uint32_t sleep_time_in_us);
*
* @attention This API can only be called before wifi_fpm_open.
*
* @param wifi_sleep_type_t type : sleep type
* @param type sleep type
*
* @return null
*/
Expand All @@ -184,8 +149,6 @@ void esp_wifi_fpm_set_sleep_type(wifi_sleep_type_t type);
/**
* @brief Get sleep type of force sleep function.
*
* @param null
*
* @return sleep type
*/
wifi_sleep_type_t esp_wifi_fpm_get_sleep_type(void);
Expand All @@ -200,28 +163,21 @@ wifi_sleep_type_t esp_wifi_fpm_get_sleep_type(void);
* • If the GPIO is still in the wakeup status, the EP8266 will enter modem-sleep mode instead;
* • If the GPIO is NOT in the wakeup status, the ESP8266 will enter light-sleep mode
*
* @param uint32_t gpio_num: GPIO number, range: [0, 15].
* gpio_int_type_t intr_status: status of GPIO interrupt to trigger the wakeup process.
* - if esp_wifi_fpm_set_sleep_type is set to be LIGHT_SLEEP_T, ESP8266 can wake up by GPIO.
* - if esp_wifi_fpm_set_sleep_type is set to be MODEM_SLEEP_T, ESP8266 can wake up by esp_wifi_fpm_do_wakeup.
* @param gpio_num GPIO number, range: [0, 15].
* gpio_int_type_t intr_status: status of GPIO interrupt to trigger the wakeup process.
* - if esp_wifi_fpm_set_sleep_type is set to be LIGHT_SLEEP_T, ESP8266 can wake up by GPIO.
* - if esp_wifi_fpm_set_sleep_type is set to be MODEM_SLEEP_T, ESP8266 can wake up by esp_wifi_fpm_do_wakeup.
* @param intr_status GPIO interrupt type
*
* @return null
*/
void esp_wifi_enable_gpio_wakeup(uint32_t gpio_num, gpio_int_type_t intr_status);

/**
* @brief Disable the function that the GPIO can wake the ESP8266 up from light-sleep mode.
*
* @param null
*
* @return null
*/
void esp_wifi_disable_gpio_wakeup(void);

/**
* @}
*/

#ifdef __cplusplus
}
#endif
2 changes: 0 additions & 2 deletions components/esp8266/include/esp_system.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -242,8 +242,6 @@ void esp_chip_info(esp_chip_info_t* out_info);
* Flash map depends on the selection when compiling, more details in document
* "2A-ESP8266__IOT_SDK_User_Manual"
*
* @param null
*
* @return enum flash_size_map
*/
flash_size_map system_get_flash_size_map(void);
Expand Down
13 changes: 8 additions & 5 deletions components/esp8266/include/esp_wifi.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -897,11 +897,14 @@ esp_err_t esp_wifi_get_event_mask(uint32_t *mask);
* the next packet is allowed to send. Otherwise, wifi_send_pkt_freedom
* will return fail.
*
* @param const void *buffer: pointer of packet
* @param int len: packet length
* @param bool en_sys_seq: follow the system's 802.11 packets sequence number or not,
* if it is true, the sequence number will be increased 1 every
* time a packet sent.
* @param ifx interface if the Wi-Fi mode is Station, the ifx should be WIFI_IF_STA. If the Wi-Fi
* mode is SoftAP, the ifx should be WIFI_IF_AP. If the Wi-Fi mode is Station+SoftAP, the
* ifx should be WIFI_IF_STA or WIFI_IF_AP. If the ifx is wrong, the API returns ESP_ERR_WIFI_IF.
* @param buffer pointer of packet
* @param len packet length
* @param en_sys_seq follow the system's 802.11 packets sequence number or not,
* if it is true, the sequence number will be increased 1 every
* time a packet sent.
*
* @return ESP_OK, succeed;
* @return ESP_FAIL, fail.
Expand Down
Loading

0 comments on commit 2a0b0f6

Please sign in to comment.