From 5c642f98c77b1c0f75ed7cb7459c4cf773153204 Mon Sep 17 00:00:00 2001 From: Kapil Gupta Date: Tue, 20 Dec 2022 12:36:07 +0530 Subject: [PATCH] wpa_supplicant: Update WPS API documentation --- components/wpa_supplicant/esp_supplicant/include/esp_wps.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/components/wpa_supplicant/esp_supplicant/include/esp_wps.h b/components/wpa_supplicant/esp_supplicant/include/esp_wps.h index 25c06782ec..5d91c1670d 100644 --- a/components/wpa_supplicant/esp_supplicant/include/esp_wps.h +++ b/components/wpa_supplicant/esp_supplicant/include/esp_wps.h @@ -113,9 +113,10 @@ esp_err_t esp_wifi_wps_disable(void); * * @attention WPS can only be used when ESP32 station is enabled. * - * @param timeout_ms : maximum blocking time before API return. - * - 0 : non-blocking - * - 1~120000 : blocking time (not supported in IDF v1.0) + * @param timeout_ms : deprecated: This argument's value will have not effect in functionality of API. + * The argument will be removed in future. + * The app should start WPS and register for WIFI events to get the status. + * WPS status is updated through WPS events. See wifi_event_t enum for more info. * * @return * - ESP_OK : succeed