diff options
| author | 2018-03-14 13:49:43 -0700 | |
|---|---|---|
| committer | 2018-03-14 13:49:43 -0700 | |
| commit | 647ee3aeff7c791bb97321c4db5c25e574eff252 (patch) | |
| tree | e5ec202a5d9ced926d5b8fc22086415f0f6b2bd4 | |
| parent | fd36a5ddeabcfe42d24bcfb1eefb54115a94481a (diff) | |
[RTT][AWARE] Minor update to distance documentation
Clarify that measured distance may be negative.
Bug: 63446747
Test: builds
Change-Id: Iff73c1e22dcf98dfce6fc69b7c9d4cf8a05af8d7
| -rw-r--r-- | wifi/java/android/net/wifi/aware/DiscoverySessionCallback.java | 3 | ||||
| -rw-r--r-- | wifi/java/android/net/wifi/rtt/RangingResult.java | 2 |
2 files changed, 4 insertions, 1 deletions
diff --git a/wifi/java/android/net/wifi/aware/DiscoverySessionCallback.java b/wifi/java/android/net/wifi/aware/DiscoverySessionCallback.java index eca840644fc6..ebf60076bd02 100644 --- a/wifi/java/android/net/wifi/aware/DiscoverySessionCallback.java +++ b/wifi/java/android/net/wifi/aware/DiscoverySessionCallback.java @@ -133,7 +133,8 @@ public class DiscoverySessionCallback { * match filter. For {@link PublishConfig#PUBLISH_TYPE_SOLICITED}, * {@link SubscribeConfig#SUBSCRIBE_TYPE_ACTIVE} discovery sessions this * is the subscriber's match filter. - * @param distanceMm The measured distance to the Publisher in mm. + * @param distanceMm The measured distance to the Publisher in mm. Note: the measured distance + * may be negative for very close devices. */ public void onServiceDiscoveredWithinRange(PeerHandle peerHandle, byte[] serviceSpecificInfo, List<byte[]> matchFilter, int distanceMm) { diff --git a/wifi/java/android/net/wifi/rtt/RangingResult.java b/wifi/java/android/net/wifi/rtt/RangingResult.java index 936a1f2b6a47..7a1ae1ad6ddb 100644 --- a/wifi/java/android/net/wifi/rtt/RangingResult.java +++ b/wifi/java/android/net/wifi/rtt/RangingResult.java @@ -147,6 +147,8 @@ public final class RangingResult implements Parcelable { * @return The distance (in mm) to the device specified by {@link #getMacAddress()} or * {@link #getPeerHandle()}. * <p> + * Note: the measured distance may be negative for very close devices. + * <p> * Only valid if {@link #getStatus()} returns {@link #STATUS_SUCCESS}, otherwise will throw an * exception. */ |