WifiManager: update docs on setWifiEnabled

Update documentation to the setWifiEnabled call reflect what a return of
false would be for.  Note: False will be returned if the caller
requested to enable/disable wifi while in softap mode or airplane mode
is active.

Bug: 64374508
Test: checked generated docs
Change-Id: I1b1de84afee3844d326e7780a935a30d7f64d220
This commit is contained in:
Rebecca Silberstein
2017-08-04 16:05:00 -07:00
parent bd27fd7368
commit 1cd6db44f2

View File

@@ -1755,9 +1755,18 @@ public class WifiManager {
/**
* Enable or disable Wi-Fi.
*
* Note: This method will return false if wifi cannot be enabled (e.g., an incompatible mode
* where the user has enabled tethering or Airplane Mode).
*
* Applications need to have the {@link android.Manifest.permission#CHANGE_WIFI_STATE}
* permission to toggle wifi. Callers without the permissions will trigger a
* {@link java.lang.SecurityException}.
*
* @param enabled {@code true} to enable, {@code false} to disable.
* @return {@code true} if the operation succeeds (or if the existing state
* is the same as the requested state).
* is the same as the requested state). False if wifi cannot be toggled on/off when the
* request is made.
*/
public boolean setWifiEnabled(boolean enabled) {
try {