Просмотр исходного кода

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

Shang Zhou 4 лет назад
Родитель
Сommit
fffed159f8
1 измененных файлов с 8 добавлено и 8 удалено
  1. 8 8
      components/esp_wifi/include/esp_wifi.h

+ 8 - 8
components/esp_wifi/include/esp_wifi.h

@@ -231,18 +231,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 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!
   *               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
   * @return
   *    - ESP_OK: succeed
   *    - ESP_OK: succeed