From fee50f1946780d6065b524f69d147756d9502193 Mon Sep 17 00:00:00 2001
From: Yu-Han Yang <yuhany@google.com>
Date: Sun, 31 Oct 2021 18:11:51 -0700
Subject: Clarify GNSS location is at the primary antenna

Bug: 199933846
Test: doc only
Change-Id: Ie883e0c221c8a5e28eaaa7feed6aea7b6003fab0
---
 location/java/android/location/LocationManager.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'location/java/android')

diff --git a/location/java/android/location/LocationManager.java b/location/java/android/location/LocationManager.java
index 42bbc7232944..0681b8da43fd 100644
--- a/location/java/android/location/LocationManager.java
+++ b/location/java/android/location/LocationManager.java
@@ -180,6 +180,11 @@ public class LocationManager {
      * <p>If present, this provider determines location using GNSS satellites. The responsiveness
      * and accuracy of location fixes may depend on GNSS signal conditions.
      *
+     * <p>Locations returned from this provider are with respect to the primary GNSS antenna
+     * position within the device. {@link #getGnssAntennaInfos()} may be used to determine the GNSS
+     * antenna position with respect to the Android Coordinate System, and convert between them if
+     * necessary. This is generally only necessary if working with high accuracy GNSS results.
+     *
      * <p>The extras Bundle for locations derived by this location provider may contain the
      * following key/value pairs:
      * <ul>
@@ -1451,6 +1456,11 @@ public class LocationManager {
      * provider availability update will be sent. As soon as the provider is enabled again, another
      * provider availability update will be sent and location updates will resume.
      *
+     * <p>Locations returned from {@link #GPS_PROVIDER} are with respect to the primary GNSS antenna
+     * position within the device. {@link #getGnssAntennaInfos()} may be used to determine the GNSS
+     * antenna position with respect to the Android Coordinate System, and convert between them if
+     * necessary. This is generally only necessary if working with high accuracy GNSS results.
+     *
      * <p>When location callbacks are invoked, the system will hold a wakelock on your
      * application's behalf for some period of time, but not indefinitely. If your application
      * requires a long running wakelock within the location callback, you should acquire it
-- 
cgit v1.2.3-59-g8ed1b