]> granicus.if.org Git - esp-idf/commitdiff
doc: Update wifi scan description
authorAnkit Daftery <ankitdaf@gmail.com>
Thu, 11 May 2017 13:53:11 +0000 (19:23 +0530)
committerAngus Gratton <gus@projectgus.com>
Wed, 17 May 2017 01:36:13 +0000 (11:36 +1000)
Code was refactored, updating documentation to reflect that

Merges https://github.com/espressif/esp-idf/pull/593

components/esp32/include/esp_wifi.h

index 10fd409cef75f74c05f81e8bbdc01f846d9e1d5f..ae78f629c3eb7e9306e285558faf8aba7de1c9c6 100755 (executable)
@@ -311,7 +311,7 @@ esp_err_t esp_wifi_deauth_sta(uint16_t aid);
   * @brief     Scan all available APs.
   *
   * @attention If this API is called, the found APs are stored in WiFi driver dynamic allocated memory and the
-  *            will be freed in esp_wifi_get_ap_list, so generally, call esp_wifi_get_ap_list to cause
+  *            will be freed in esp_wifi_scan_get_ap_records, so generally, call esp_wifi_scan_get_ap_records to cause
   *            the memory to be freed once the scan is done
   * @attention The values of maximum active scan time and passive scan time per channel are limited to 1500 milliseconds.
   *            Values above 1500ms may cause station to disconnect from AP and are not recommended.