docs: update the API description for esp-wifi_scan_get_ap_records

Lindazhxy · espressif-bot · commit afab2130fd3f · 2025-02-19T10:48:43.000+08:00
diff --git a/components/esp_wifi/include/esp_wifi.h b/components/esp_wifi/include/esp_wifi.h
@@ -583,7 +583,7 @@ esp_err_t esp_wifi_scan_stop(void);
 esp_err_t esp_wifi_scan_get_ap_num(uint16_t *number);
 
 /**
-  * @brief     Get AP list found in last scan.
+  * @brief     Retrieve the list of APs found during the last scan. The returned AP list is sorted in descending order based on RSSI.
   *
   * @attention  This API will free all memory occupied by scanned AP list.
   *

Original file line number	Diff line number	Diff line change
`@@ -583,7 +583,7 @@ esp_err_t esp_wifi_scan_stop(void);`
`583`	`583`	`esp_err_t esp_wifi_scan_get_ap_num(uint16_t *number);`
`584`	`584`
`585`	`585`	`/**`
`586`		`- * @brief Get AP list found in last scan.`
	`586`	`+ * @brief Retrieve the list of APs found during the last scan. The returned AP list is sorted in descending order based on RSSI.`
`587`	`587`	`*`
`588`	`588`	`* @attention This API will free all memory occupied by scanned AP list.`
`589`	`589`	`*`