From ff4e69f2be10651d5a5131a8c4148c7f11d338db Mon Sep 17 00:00:00 2001
From: Chalard Jean <jchalard@google.com>
Date: Thu, 8 Apr 2021 18:08:49 +0900
Subject: [PATCH] Add doc for NetworkScore#getLegacyInt

Test: comment-only change
Fixes: 184786246
Change-Id: I8306f01f3d247986683e272074047e3ad190f68e
---
 framework/src/android/net/NetworkScore.java | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/framework/src/android/net/NetworkScore.java b/framework/src/android/net/NetworkScore.java
index 0dee225a0e..b0752e99d8 100644
--- a/framework/src/android/net/NetworkScore.java
+++ b/framework/src/android/net/NetworkScore.java
@@ -93,6 +93,10 @@ public final class NetworkScore implements Parcelable {
         mKeepConnectedReason = in.readInt();
     }
 
+    /**
+     * Get the legacy int score embedded in this NetworkScore.
+     * @see Builder#setLegacyInt(int)
+     */
     public int getLegacyInt() {
         return mLegacyInt;
     }
@@ -212,7 +216,9 @@ public final class NetworkScore implements Parcelable {
         /**
          * Sets the legacy int for this score.
          *
-         * Do not rely on this. It will be gone by the time S is released.
+         * This will be used for measurements and logs, but will no longer be used for ranking
+         * networks against each other. Callers that existed before Android S should send what
+         * they used to send as the int score.
          *
          * @param score the legacy int
          * @return this