Add javadoc to GnssAntennaInfo#getCarrierFrequencyMHz()
Flag: DOCS_ONLY
Bug: 284427002
Test: javadoc update only
Change-Id: Icb80f881dc834222c5aa96f18d7acce23188a144
diff --git a/location/java/android/location/GnssAntennaInfo.java b/location/java/android/location/GnssAntennaInfo.java
index 3558dd5..39ce8a3 100644
--- a/location/java/android/location/GnssAntennaInfo.java
+++ b/location/java/android/location/GnssAntennaInfo.java
@@ -33,6 +33,8 @@
*
* <p> Antenna info parameters are measured for each specific device model by the device
* manufacturers and provided to the Android framework.
+ *
+ * <p> {@link GnssAntennaInfo} is returned per frequency band at the center frequency of the band.
*/
public final class GnssAntennaInfo implements Parcelable {
private final double mCarrierFrequencyMHz;
@@ -479,6 +481,7 @@
}
}
+ /** Returns the center frequency of the corresponding carrier frequency band. */
@FloatRange(from = 0.0f)
public double getCarrierFrequencyMHz() {
return mCarrierFrequencyMHz;