doc: Update wifi scan description

Code was refactored, updating documentation to reflect that

Merges https://github.com/espressif/esp-idf/pull/593
This commit is contained in:
Ankit Daftery 2017-05-11 19:23:11 +05:30 committed by Angus Gratton
parent 31de20a217
commit 66191fc0b5

View File

@ -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.