Add docs to SatellitePvt class

Bug: 183670215
Test: comment only
Change-Id: Ie9cef6f22d8a9b020ce081ca18e02f43eb259188

1 files changed, 8 insertions, 1 deletions

diff --git a/location/java/android/location/SatellitePvt.java b/location/java/android/location/SatellitePvt.java
index 144fa1341bd6..27c7eda1dae3 100644
--- a/location/java/android/location/SatellitePvt.java
+++ b/location/java/android/location/SatellitePvt.java
@@ -25,8 +25,9 @@ import android.os.Parcelable;
 
 /**
  * A class that contains GNSS satellite position, velocity and time information at the
- * signal transmission time {@link GnssMeasurement#getReceivedSvTimeNanos()}.
+ * same signal transmission time {@link GnssMeasurement#getReceivedSvTimeNanos()}.
  *
+ * <p>The position and velocity must be in ECEF coordinates.
  * @hide
  */
 @SystemApi
@@ -39,6 +40,9 @@ public final class SatellitePvt implements Parcelable {
 
     /**
      * Class containing estimates of the satellite position fields in ECEF coordinate frame.
+     *
+     * <p>The satellite position must be defined at the time of transmission of the signal
+     * receivedSvTimeNs.
      */
     public static final class PositionEcef implements Parcelable {
         private final double mXMeters;
@@ -133,6 +137,9 @@ public final class SatellitePvt implements Parcelable {
 
     /**
      * Class containing estimates of the satellite velocity fields in the ECEF coordinate frame.
+     *
+     * <p>The satellite velocity must be defined at the time of transmission of the signal
+     * receivedSvTimeNs.
      */
     public static final class VelocityEcef implements Parcelable {
         private final double mXMetersPerSecond;