Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d1d95ec6 authored by lesl's avatar lesl Committed by Les Lee
Browse files

wifi: Correct java document description 

There are tethered mode and local mode API for softap.
Update API description which only provide function for tethered mode.

Test: make docs frameworks/base/wifi/
Bug: 137675368
Change-Id: I1719be50b78bc258606eac3bf5595aca59d7a9f4
parent d2b59cda

wifi/java/android/net/wifi/WifiManager.java

+9 −9
Original line number Diff line number Diff line
@@ -2982,7 +2982,7 @@ public class WifiManager { 
    }



    /**

     * Start Soft AP (hotspot) mode with the specified configuration.

     * Start Soft AP (hotspot) mode for tethering purposes with the specified configuration.

     * Note that starting Soft AP mode may disable station mode operation if the device does not

     * support concurrency.

     * @param wifiConfig SSID, security and channel details as part of WifiConfiguration, or null to
@@ -3278,7 +3278,7 @@ public class WifiManager { 
    }



    /**

     * Gets the Wi-Fi enabled state.

     * Gets the tethered Wi-Fi hotspot enabled state.

     * @return One of {@link #WIFI_AP_STATE_DISABLED},

     *         {@link #WIFI_AP_STATE_DISABLING}, {@link #WIFI_AP_STATE_ENABLED},

     *         {@link #WIFI_AP_STATE_ENABLING}, {@link #WIFI_AP_STATE_FAILED}
@@ -3297,8 +3297,8 @@ public class WifiManager { 
    }



    /**

     * Return whether Wi-Fi AP is enabled or disabled.

     * @return {@code true} if Wi-Fi AP is enabled

     * Return whether tethered Wi-Fi AP is enabled or disabled.

     * @return {@code true} if tethered  Wi-Fi AP is enabled

     * @see #getWifiApState()

     *

     * @hide
@@ -3310,7 +3310,7 @@ public class WifiManager { 
    }



    /**

     * Gets the Wi-Fi AP Configuration.

     * Gets the tethered Wi-Fi AP Configuration.

     * @return AP details in WifiConfiguration

     *

     * Note that AP detail may contain configuration which is cannot be represented
@@ -3332,7 +3332,7 @@ public class WifiManager { 
    }



    /**

     * Gets the Wi-Fi AP Configuration.

     * Gets the Wi-Fi tethered AP Configuration.

     * @return AP details in {@link SoftApConfiguration}

     *

     * @hide
@@ -3349,7 +3349,7 @@ public class WifiManager { 
    }



    /**

     * Sets the Wi-Fi AP Configuration.

     * Sets the tethered Wi-Fi AP Configuration.

     * @return {@code true} if the operation succeeded, {@code false} otherwise

     *

     * @deprecated This API is deprecated. Use {@link #setSoftApConfiguration(SoftApConfiguration)}
@@ -3368,9 +3368,9 @@ public class WifiManager { 
    }



    /**

     * Sets the Wi-Fi AP Configuration.

     * Sets the tethered Wi-Fi AP Configuration.

     *

     * If the API is called while the soft AP is enabled, the configuration will apply to

     * If the API is called while the tethered soft AP is enabled, the configuration will apply to

     * the current soft AP if the new configuration only includes

     * {@link SoftApConfiguration.Builder#setMaxNumberOfClients(int)}

     * or {@link SoftApConfiguration.Builder#setShutdownTimeoutMillis(int)}