espressif/ESP8266_RTOS_SDK
1
0
Fork 0
mirror of https://github.com/espressif/ESP8266_RTOS_SDK.git synced 2025-06-03 11:29:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(tcpip_adapter): Make tcpip_adapter doxygen style

Browse Source
This commit is contained in:
Dong Heng
2018-08-22 16:21:19 +08:00
parent b9f50d0905
commit c601b5aae9
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
components/tcpip_adapter/include/tcpip_adapter.h
View File

@ -493,9 +493,9 @@ esp_err_t tcpip_adapter_eth_input(void *buffer, uint16_t len, void *eb);
*
* This function should be installed by esp_wifi_reg_rxcb, so WiFi packets will be forward to TCPIP stack.
*
* @param[in] void *buffer: the received data point
* @param[in] uint16_t len: the received data length
* @param[in] void *eb: parameter
* @param[in] buffer: the received data point
* @param[in] len: the received data length
* @param[in] eb: parameter
*
* @return ESP_OK
*/
@ -506,9 +506,9 @@ esp_err_t tcpip_adapter_sta_input(void *buffer, uint16_t len, void *eb);
*
* This function should be installed by esp_wifi_reg_rxcb, so WiFi packets will be forward to TCPIP stack.
*
* @param[in] void *buffer: the received data point
* @param[in] uint16_t len: the received data length
* @param[in] void *eb: parameter
* @param[in] buffer: the received data point
* @param[in] len: the received data length
* @param[in] eb: parameter
*
* @return ESP_OK
*/
@ -519,7 +519,7 @@ esp_err_t tcpip_adapter_ap_input(void *buffer, uint16_t len, void *eb);
*
* Get WiFi interface from TCPIP interface struct pointer.
*
* @param[in] void *dev: adapter interface
* @param[in] dev: adapter interface
*
* @return ESP_IF_WIFI_STA
* ESP_IF_WIFI_AP
@ -531,8 +531,8 @@ esp_interface_t tcpip_adapter_get_esp_if(void *dev);
/**
* @brief Get the station information list
*
* @param[in] wifi_sta_list_t *wifi_sta_list: station list info
* @param[out] tcpip_adapter_sta_list_t *tcpip_sta_list: station list info
* @param[in] wifi_sta_list: station list info
* @param[out] tcpip_sta_list: station list info
*
* @return ESP_OK
* ESP_ERR_TCPIP_ADAPTER_NO_MEM
@ -569,7 +569,7 @@ esp_err_t tcpip_adapter_get_hostname(tcpip_adapter_if_t tcpip_if, const char **h
* @brief Get the LwIP netif* that is assigned to the interface
*
* @param[in] tcpip_if: the interface which we will get the hostname
* @param[out] void ** netif: pointer to fill the resulting interface
* @param[out] netif: pointer to fill the resulting interface
*
* @return ESP_OK:success
* ESP_ERR_TCPIP_ADAPTER_IF_NOT_READY:interface status error