From d017319f57fdfbbc7eb711f4906f7e9731af29bd Mon Sep 17 00:00:00 2001 From: Pierre Fite-Georgel Date: Thu, 4 Apr 2019 13:27:07 -0700 Subject: Adding documentation to getElapsedRealtimeUncertaintyNanos following api council guidance. Test: N/A comment only Bug: 129769397 Change-Id: I906494b0b72898149322959f5900626a12d6d86b (cherry picked from commit d6d4d1efa2084c79161c1ffac303477e9d8e72fe) --- location/java/android/location/Location.java | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'location/java/android') diff --git a/location/java/android/location/Location.java b/location/java/android/location/Location.java index 673b4112d423..69ae8cb328a4 100644 --- a/location/java/android/location/Location.java +++ b/location/java/android/location/Location.java @@ -599,6 +599,14 @@ public class Location implements Parcelable { * ElapsedRealtimeNanos timestamp, with the reported measurements in * nanoseconds (68% confidence). * + * This means that we have 68% confidence that the true timestamp of the + * event is within ElapsedReatimeNanos +/- uncertainty. + * + * Example : + * - getElapsedRealtimeNanos() returns 10000000 + * - getElapsedRealtimeUncertaintyNanos() returns 1000000 (equivalent to 1millisecond) + * This means that the event most likely happened between 9000000 and 11000000. + * * @return uncertainty of elapsed real-time of fix, in nanoseconds. */ public long getElapsedRealtimeUncertaintyNanos() { -- cgit v1.2.3-59-g8ed1b