Fix default behavior of basic disconnect method variant. Change erase…

…ap to meaningful name 'eraseCredentials'. Fix comments.
esp8266 · d-a-v · Dec 15, 2022 · Dec 12, 2022 · Dec 14, 2022 · Dec 14, 2022
commit 4ecaf68a8879a38ce716e6a23d69decf605eb1cc
diff --git a/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp b/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.cpp
@@ -353,28 +353,29 @@ bool ESP8266WiFiSTAClass::reconnect() {
 }
 
 /**
- * Disconnect from the network
- * @param wifioff
+ * Disconnect from the network with clearing saved credentials
+ * @param wifioff Bool indicating whether STA should be disabled.
  * @return  one value of wl_status_t enum
     */
 bool ESP8266WiFiSTAClass::disconnect(bool wifioff) {
-    return disconnect(wifioff, false);
+    // Disconnect with clearing saved credentials.
+    return disconnect(wifioff, true);
 }
 
 /**
  * Disconnect from the network
- * @param wifioff
- * @param eraseap
+ * @param wifioff Bool indicating whether STA should be disabled. 
+ * @param eraseCredentials Bool indicating whether saved credentials should be erased.
  * @return  one value of wl_status_t enum
  */
-bool ESP8266WiFiSTAClass::disconnect(bool wifioff, bool eraseap) {
+bool ESP8266WiFiSTAClass::disconnect(bool wifioff, bool eraseCredentials) {
     bool ret = false;
 
     // Read current config.
     struct station_config conf;
     wifi_station_get_config(&conf);
 
-    if (eraseap) {
+    if (eraseCredentials) {
         memset(&conf.ssid, 0, sizeof(conf.ssid));
         memset(&conf.password, 0, sizeof(conf.password));
     }

diff --git a/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.h b/libraries/ESP8266WiFi/src/ESP8266WiFiSTA.h
@@ -50,7 +50,7 @@ class ESP8266WiFiSTAClass: public LwipIntf {
         bool reconnect();
 
         bool disconnect(bool wifioff = false);
-        bool disconnect(bool wifioff, bool eraseap);
+        bool disconnect(bool wifioff, bool eraseCredentials);
 
         bool isConnected();