diff options
author | Jeff Davidson <jpd@google.com> | 2014-08-20 20:41:43 +0000 |
---|---|---|
committer | Android (Google) Code Review <android-gerrit@google.com> | 2014-08-20 20:15:45 +0000 |
commit | 833dcd4bea5cadccaa55f9a06942bb36d01d73ac (patch) | |
tree | e7afec6bf1ad433bfcb17635bddc302bece355c8 | |
parent | 550bd55257d08030641e164982bfa7192e3b9850 (diff) | |
parent | e4ce619880e831992b005c17dfabb7800994d0c7 (diff) | |
download | frameworks_base-833dcd4bea5cadccaa55f9a06942bb36d01d73ac.zip frameworks_base-833dcd4bea5cadccaa55f9a06942bb36d01d73ac.tar.gz frameworks_base-833dcd4bea5cadccaa55f9a06942bb36d01d73ac.tar.bz2 |
Merge "Improve documentation of ScanResult and WifiInfo." into lmp-dev
-rw-r--r-- | wifi/java/android/net/wifi/ScanResult.java | 7 | ||||
-rw-r--r-- | wifi/java/android/net/wifi/WifiInfo.java | 6 |
2 files changed, 10 insertions, 3 deletions
diff --git a/wifi/java/android/net/wifi/ScanResult.java b/wifi/java/android/net/wifi/ScanResult.java index a561dc2..a01a6b6 100644 --- a/wifi/java/android/net/wifi/ScanResult.java +++ b/wifi/java/android/net/wifi/ScanResult.java @@ -18,8 +18,8 @@ package android.net.wifi; import android.net.wifi.passpoint.WifiPasspointInfo; import android.net.wifi.passpoint.WifiPasspointManager; -import android.os.Parcelable; import android.os.Parcel; +import android.os.Parcelable; /** * Describes information about a detected access point. In addition @@ -48,7 +48,10 @@ public class ScanResult implements Parcelable { */ public String capabilities; /** - * The detected signal level in dBm. + * The detected signal level in dBm, also known as the RSSI. + * + * <p>Use {@link android.net.wifi.WifiManager#calculateSignalLevel} to convert this number into + * an absolute signal level which can be displayed to a user. */ public int level; /** diff --git a/wifi/java/android/net/wifi/WifiInfo.java b/wifi/java/android/net/wifi/WifiInfo.java index e808136..44a7108 100644 --- a/wifi/java/android/net/wifi/WifiInfo.java +++ b/wifi/java/android/net/wifi/WifiInfo.java @@ -323,7 +323,11 @@ public class WifiInfo implements Parcelable { /** * Returns the received signal strength indicator of the current 802.11 * network, in dBm. - * @return the RSSI, in the range -127 to 200 + * + * <p>Use {@link android.net.wifi.WifiManager#calculateSignalLevel} to convert this number into + * an absolute signal level which can be displayed to a user. + * + * @return the RSSI. */ public int getRssi() { return mRssi; |