Merge branch 'bugfix/update_wps_api_documentation_v4.4' into 'release/v4.4'

jack0c · jack0c · commit fa3c3a8b4606 · 2023-03-31T13:58:42.000+08:00
wpa_supplicant: Update WPS API documentation (v4.4)

See merge request espressif/esp-idf!23014
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -113,9 +113,10 @@ esp_err_t esp_wifi_wps_disable(void);`
`113`	`113`	`*`
`114`	`114`	`* @attention WPS can only be used when ESP32 station is enabled.`
`115`	`115`	`*`
`116`		`- * @param timeout_ms : maximum blocking time before API return.`
`117`		`- * - 0 : non-blocking`
`118`		`- * - 1~120000 : blocking time (not supported in IDF v1.0)`
	`116`	`+ * @param timeout_ms : deprecated: This argument's value will have not effect in functionality of API.`
	`117`	`+ * The argument will be removed in future.`
	`118`	`+ * The app should start WPS and register for WIFI events to get the status.`
	`119`	`+ * WPS status is updated through WPS events. See wifi_event_t enum for more info.`
`119`	`120`	`*`
`120`	`121`	`* @return`
`121`	`122`	`* - ESP_OK : succeed`