]> granicus.if.org Git - esp-idf/commitdiff
correct modem sleep API description
authorXia Xiaotian <xiaxiaotian@espressif.com>
Wed, 13 Jun 2018 07:44:59 +0000 (15:44 +0800)
committerXia Xiaotian <xiaxiaotian@espressif.com>
Wed, 13 Jun 2018 07:44:59 +0000 (15:44 +0800)
components/esp32/include/esp_wifi.h

index 88f033096839a87857f8798d6bb38ae34a3847d8..d4c11c387096af4ea8529866daa7cd7151949fb0 100644 (file)
@@ -428,24 +428,24 @@ esp_err_t esp_wifi_scan_get_ap_records(uint16_t *number, wifi_ap_record_t *ap_re
 esp_err_t esp_wifi_sta_get_ap_info(wifi_ap_record_t *ap_info);
 
 /**
-  * @brief     Set current power save type
+  * @brief     Set current WiFi power save type
   *
-  * @attention Default power save type is WIFI_PS_NONE.
+  * @attention Default power save type is WIFI_PS_MIN_MODEM.
   *
   * @param     type  power save type
   *
-  * @return    ESP_ERR_NOT_SUPPORTED: not supported yet
+  * @return    ESP_OK: succeed
   */
 esp_err_t esp_wifi_set_ps(wifi_ps_type_t type);
 
 /**
-  * @brief     Get current power save type
+  * @brief     Get current WiFi power save type
   *
-  * @attention Default power save type is WIFI_PS_NONE.
+  * @attention Default power save type is WIFI_PS_MIN_MODEM.
   *
   * @param[out]  type: store current power save type
   *
-  * @return    ESP_ERR_NOT_SUPPORTED: not supported yet
+  * @return    ESP_OK: succeed
   */
 esp_err_t esp_wifi_get_ps(wifi_ps_type_t *type);