From 1bc58a37f50b1e65067188f1f131299167a98965 Mon Sep 17 00:00:00 2001
From: Rupesh Bansal <brup@google.com>
Date: Tue, 26 Apr 2022 14:02:27 +0000
Subject: [PATCH] Add documentation for LayoutParams.preferredRefreshRate

Adding documentation to clarify when should the applications use LayoutParams.preferredRefreshRate
over LayoutParams.preferredDisplayModeId

Bug: 227781356
Test: built locally
Change-Id: I75f10f7ea2c3386f8382af3012241316e540bd83
---
 core/java/android/view/WindowManager.java | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/core/java/android/view/WindowManager.java b/core/java/android/view/WindowManager.java
index cfe44bbbf3c69..ec816764b9690 100644
--- a/core/java/android/view/WindowManager.java
+++ b/core/java/android/view/WindowManager.java
@@ -3100,10 +3100,14 @@ public interface WindowManager extends ViewManager {
 
         /**
          * The preferred refresh rate for the window.
-         *
+         * <p>
          * This must be one of the supported refresh rates obtained for the display(s) the window
          * is on. The selected refresh rate will be applied to the display's default mode.
-         *
+         * <p>
+         * This should be used in favor of {@link LayoutParams#preferredDisplayModeId} for
+         * applications that want to specify the refresh rate, but do not want to specify a
+         * preference for any other displayMode properties (e.g., resolution).
+         * <p>
          * This value is ignored if {@link #preferredDisplayModeId} is set.
          *
          * @see Display#getSupportedRefreshRates()