Merge "Improve documentation of ScanResult and WifiInfo." into lmp-dev

This commit is contained in:
Jeff Davidson
2014-08-20 20:41:43 +00:00
committed by Android (Google) Code Review
2 changed files with 10 additions and 3 deletions

View File

@@ -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;
/**

View File

@@ -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;