From 0d27285e8f8e41143303d48d19f42d9029ebd8ce Mon Sep 17 00:00:00 2001
From: Adrian Roos <roosa@google.com>
Date: Tue, 14 Apr 2020 16:37:19 +0200
Subject: [PATCH] WindowInsetsAnimationController: Clarify finish javadoc

Fixes: 151707124
Test: make checkbuild
Change-Id: I41a24d65558cc47196548bd2026b5164c3e04196
---
 core/java/android/view/WindowInsetsAnimationController.java | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/core/java/android/view/WindowInsetsAnimationController.java b/core/java/android/view/WindowInsetsAnimationController.java
index c191a54283fb3..fb9d05e2d730c 100644
--- a/core/java/android/view/WindowInsetsAnimationController.java
+++ b/core/java/android/view/WindowInsetsAnimationController.java
@@ -141,7 +141,10 @@ public interface WindowInsetsAnimationController {
     /**
      * Finishes the animation, and leaves the windows shown or hidden.
      * <p>
-     * After invoking {@link #finish(boolean)}, this instance is no longer {@link #isReady ready}.
+     * After invoking {@link #finish}, this instance is no longer {@link #isReady ready}.
+     * <p>
+     * Note: Finishing an animation implicitly {@link #setInsetsAndAlpha sets insets and alpha}
+     * according to the requested end state without any further animation.
      *
      * @param shown if {@code true}, the windows will be shown after finishing the
      *              animation. Otherwise they will be hidden.