alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: Update miswritten and abbreviated words and syntax errors for initialize WiFi section in esp_wifi.h header file

Browse Source
This commit is contained in:
Shang Zhou 2021-11-26 19:11:09 +08:00 committed by muhaidong
parent 6baac84d4a
commit 6f8ad7eb5e
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
components/esp_wifi/include/esp_wifi.h
View File

@ -221,18 +221,18 @@ extern uint64_t g_wifi_feature_caps;
};
/**
* @brief Init WiFi
* Alloc resource for WiFi driver, such as WiFi control structure, RX/TX buffer,
* WiFi NVS structure etc, this WiFi also start WiFi task
* @brief Initialize WiFi
* Allocate resource for WiFi driver, such as WiFi control structure, RX/TX buffer,
* WiFi NVS structure etc. This WiFi also starts WiFi task
*
* @attention 1. This API must be called before all other WiFi API can be called
* @attention 2. Always use WIFI_INIT_CONFIG_DEFAULT macro to init the config to default values, this can
* guarantee all the fields got correct value when more fields are added into wifi_init_config_t
* in future release. If you want to set your owner initial values, overwrite the default values
* which are set by WIFI_INIT_CONFIG_DEFAULT, please be notified that the field 'magic' of
* @attention 2. Always use WIFI_INIT_CONFIG_DEFAULT macro to initialize the configuration to default values, this can
* guarantee all the fields get correct value when more fields are added into wifi_init_config_t
* in future release. If you want to set your own initial values, overwrite the default values
* which are set by WIFI_INIT_CONFIG_DEFAULT. Please be notified that the field 'magic' of
* wifi_init_config_t should always be WIFI_INIT_CONFIG_MAGIC!
*
* @param config pointer to WiFi init configuration structure; can point to a temporary variable.
* @param config pointer to WiFi initialized configuration structure; can point to a temporary variable.
*
* @return
* - ESP_OK: succeed