espressif/ESP8266_RTOS_SDK
1
0
Fork 0
mirror of https://github.com/espressif/ESP8266_RTOS_SDK.git synced 2025-08-06 15:15:15 +08:00
Code Issues Packages 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

13
components/esp8266/include/esp_wifi.h
View File

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