summaryrefslogtreecommitdiff
path: root/location
diff options
context:
space:
mode:
author Yu-Han Yang <yuhany@google.com> 2024-12-13 18:55:45 +0000
committer Yu-Han Yang <yuhany@google.com> 2024-12-16 17:56:26 +0000
commitf534557c215786708802cc6c40c7bdd2f036c906 (patch)
tree9dc4d1f52e1cf3b638401874ba52b9e916e81bcc /location
parent3116d256aa8ead0290b05cb15211699c94a4b24b (diff)
Add javadoc to GnssAntennaInfo#getCarrierFrequencyMHz()
Flag: DOCS_ONLY Bug: 284427002 Test: javadoc update only Change-Id: Icb80f881dc834222c5aa96f18d7acce23188a144
Diffstat (limited to 'location')
-rw-r--r--location/java/android/location/GnssAntennaInfo.java3
1 files changed, 3 insertions, 0 deletions
diff --git a/location/java/android/location/GnssAntennaInfo.java b/location/java/android/location/GnssAntennaInfo.java
index 3558dd501d20..39ce8a328838 100644
--- a/location/java/android/location/GnssAntennaInfo.java
+++ b/location/java/android/location/GnssAntennaInfo.java
@@ -33,6 +33,8 @@ import java.util.Objects;
*
* <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 @@ public final class GnssAntennaInfo implements Parcelable {
}
}
+ /** Returns the center frequency of the corresponding carrier frequency band. */
@FloatRange(from = 0.0f)
public double getCarrierFrequencyMHz() {
return mCarrierFrequencyMHz;