From e1fc791cff24b772e372b5e870e8fc837de07fbe Mon Sep 17 00:00:00 2001 From: Tobias Sargeant Date: Tue, 19 Mar 2019 12:16:22 +0000 Subject: [PATCH] [wv-docs] Document force dark default, and behaviour of FORCE_DARK_AUTO This adds a reference to the View method that controls framework force dark, which impacts how FORCE_DARK_AUTO is interpreted. It also documents that FORCE_DARK_AUTO is the default. Test: documentation only change Fixes: 128704481 Change-Id: I88e7996362da5b092b269c313e37ef9253b12872 --- core/java/android/webkit/WebSettings.java | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/core/java/android/webkit/WebSettings.java b/core/java/android/webkit/WebSettings.java index 494eb0358ab92..a46580dcc539b 100644 --- a/core/java/android/webkit/WebSettings.java +++ b/core/java/android/webkit/WebSettings.java @@ -245,10 +245,11 @@ public abstract class WebSettings { /** * Used with {@link #setForceDark} * - * Enable force dark, dependent on the state of the WebView parent. If the WebView parent view - * is being automatically rendered in dark mode, then WebView content will be rendered so as to - * emulate a dark theme. WebViews that are not attached to the view hierarchy will not be - * inverted. + * Enable force dark dependent on the state of the WebView parent view. If the WebView parent + * view is being automatically force darkened + * (see: {@link android.view.View#setForceDarkAllowed}), then WebView content will be rendered + * so as to emulate a dark theme. WebViews that are not attached to the view hierarchy will not + * be inverted. */ public static final int FORCE_DARK_AUTO = 1; @@ -1466,6 +1467,8 @@ public abstract class WebSettings { /** * Set the force dark mode for this WebView. + * + * @param forceDark the force dark mode to set. */ public void setForceDark(@ForceDark int forceDark) { // Stub implementation to satisfy Roboelectrc shadows that don't override this yet. @@ -1474,6 +1477,8 @@ public abstract class WebSettings { /** * Get the force dark mode for this WebView. * + * The default force dark mode is {@link #FORCE_DARK_AUTO} + * * @return the currently set force dark mode. */ public @ForceDark int getForceDark() {