From 473ebd77d50f8d06d37d0202c45842cbfa63ec81 Mon Sep 17 00:00:00 2001
From: Shinru Han <shinruhan@google.com>
Date: Tue, 16 Mar 2021 14:21:48 +0800
Subject: Add comment for getMagnitude in CorrelationVector

Bug: 179389247
Test: comment only
Change-Id: I826e7a34940267a32e37ed57074e17c0c17b1515
---
 location/java/android/location/CorrelationVector.java | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'location/java')

diff --git a/location/java/android/location/CorrelationVector.java b/location/java/android/location/CorrelationVector.java
index 4b6e6882b50a..718977ff4296 100644
--- a/location/java/android/location/CorrelationVector.java
+++ b/location/java/android/location/CorrelationVector.java
@@ -77,6 +77,9 @@ public final class CorrelationVector implements Parcelable {
      * be encoded as signed 16 bit integer where 1 is represented by 32767 and -1 is represented
      * by -32768.
      *
+     * <p>The values are quantized using a 16bit integer to save on the data size since the array
+     * contains real data and it might grow.
+     *
      */
     @NonNull
     public int[] getMagnitude() {
-- 
cgit v1.2.3-59-g8ed1b