Adding documentation to getElapsedRealtimeUncertaintyNanos following api council guidance.

Test: N/A comment only
Bug: 129769397
Change-Id: I906494b0b72898149322959f5900626a12d6d86b
(cherry picked from commit d6d4d1efa2)
This commit is contained in:
Pierre Fite-Georgel
2019-04-04 13:27:07 -07:00
committed by Pierre Fite-georgel
parent 113f85298b
commit d017319f57

View File

@@ -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() {