File tree 2 files changed +17
-20
lines changed
2 files changed +17
-20
lines changed Original file line number Diff line number Diff line change @@ -446,26 +446,12 @@ Return the connection state.
446
446
setAutoConnect
447
447
**************
448
448
449
- Function used to set the automatic connection.
450
-
451
- .. code-block :: arduino
452
-
453
- bool setAutoConnect(bool autoConnect);
454
-
455
- Where:
456
-
457
- * ``bool autoConnect `` is set to ``true `` to enable this option.
449
+ Function is deprecated.
458
450
459
451
getAutoConnect
460
452
**************
461
453
462
- Function used to get the automatic connection setting value.
463
-
464
- .. code-block :: arduino
465
-
466
- bool getAutoConnect();
467
-
468
- The function will return ``true `` if the setting is enabled.
454
+ Function is deprecated.
469
455
470
456
setAutoReconnect
471
457
****************
@@ -484,11 +470,12 @@ getAutoReconnect
484
470
****************
485
471
486
472
Function used to get the automatic reconnection if the connection is lost.
473
+
487
474
.. code-block :: arduino
488
475
489
476
bool getAutoReconnect();
490
477
491
- The function will return ``true`` if this setting is enabled.
478
+ The function will return ``true `` if this setting is enabled.
492
479
493
480
WiFiMulti
494
481
---------
Original file line number Diff line number Diff line change @@ -430,8 +430,9 @@ void WiFiSTAClass::setSortMethod(wifi_sort_method_t sortMethod)
430
430
}
431
431
432
432
/* *
433
- * Setting the ESP32 station to connect to the AP (which is recorded)
433
+ * Deprecated. Setting the ESP32 station to connect to the AP (which is recorded)
434
434
* automatically or not when powered on. Enable auto-connect by default.
435
+ * @deprecated use `setAutoReconnect`
435
436
* @param autoConnect bool
436
437
* @return if saved
437
438
*/
@@ -441,21 +442,30 @@ bool WiFiSTAClass::setAutoConnect(bool autoConnect)
441
442
}
442
443
443
444
/* *
444
- * Checks if ESP32 station mode will connect to AP
445
+ * Deprecated. Checks if ESP32 station mode will connect to AP
445
446
* automatically or not when it is powered on.
447
+ * @deprecated use `getAutoReconnect`
446
448
* @return auto connect
447
449
*/
448
450
bool WiFiSTAClass::getAutoConnect ()
449
451
{
450
452
return false ;// now deprecated
451
453
}
452
454
455
+ /* *
456
+ * Function used to set the automatic reconnection if the connection is lost.
457
+ * @param autoReconnect `true` to enable this option.
458
+ * @return true
459
+ */
453
460
bool WiFiSTAClass::setAutoReconnect (bool autoReconnect)
454
461
{
455
462
_autoReconnect = autoReconnect;
456
463
return true ;
457
464
}
458
-
465
+ /* *
466
+ * Function used to get the automatic reconnection if the connection is lost.
467
+ * @return The function will return `true` if this setting is enabled.
468
+ */
459
469
bool WiFiSTAClass::getAutoReconnect ()
460
470
{
461
471
return _autoReconnect;
You can’t perform that action at this time.
0 commit comments