Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7051dd1e authored by Nate Fischer's avatar Nate Fischer
Browse files

WebView: make notes in docs stand out 

This CL rewrites notes to use the 'note' CSS class, to help them stand
out. This isn't every instance of 'note', but it catches the handful
where I think there's a readability benefit to the new format.

This changes a few other non-public notes for the sake of consistency.

Change-Id: Icf62e34a719c79f74e74abdb55f1be42939c2f9e
Fixes: 68324591
Test: make -j40 docs (and manually verify it looks good)
parent c4478d5b

core/java/android/webkit/ServiceWorkerClient.java

+3 −3
Original line number Diff line number Diff line
@@ -27,9 +27,9 @@ public class ServiceWorkerClient { 
     * application to return the data. If the return value is {@code null}, the

     * Service Worker will continue to load the resource as usual.

     * Otherwise, the return response and data will be used.

     * NOTE: This method is called on a thread other than the UI thread

     * so clients should exercise caution when accessing private data

     * or the view system.

     *

     * <p class="note"><b>Note:</b> This method is called on a thread other than the UI thread so

     * clients should exercise caution when accessing private data or the view system.

     *

     * @param request Object containing the details of the request.

     * @return A {@link android.webkit.WebResourceResponse} containing the

core/java/android/webkit/WebView.java

+1 −1
Original line number Diff line number Diff line
@@ -191,7 +191,7 @@ import java.util.Map; 
 * {@link #getSettings() WebSettings}.{@link WebSettings#setBuiltInZoomControls(boolean)}

 * (introduced in API level {@link android.os.Build.VERSION_CODES#CUPCAKE}).

 *

 * <p>NOTE: Using zoom if either the height or width is set to

 * <p class="note"><b>Note:</b> Using zoom if either the height or width is set to

 * {@link android.view.ViewGroup.LayoutParams#WRAP_CONTENT} may lead to undefined behavior

 * and should be avoided.

 *

core/java/android/webkit/WebViewClient.java

+12 −8
Original line number Diff line number Diff line
@@ -149,13 +149,15 @@ public class WebViewClient { 
     * Notify the host application of a resource request and allow the

     * application to return the data.  If the return value is {@code null}, the WebView

     * will continue to load the resource as usual.  Otherwise, the return

     * response and data will be used.  NOTE: This method is called on a thread

     * response and data will be used.

     *

     * <p class="note"><b>Note:</b> This method is called on a thread

     * other than the UI thread so clients should exercise caution

     * when accessing private data or the view system.

     *

     * <p>Note: when Safe Browsing is enabled, these URLs still undergo Safe Browsing checks. If

     * this is undesired, whitelist the URL with {@link WebView#setSafeBrowsingWhitelist} or ignore

     * the warning with {@link #onSafeBrowsingHit}.

     * <p class="note"><b>Note:</b> When Safe Browsing is enabled, these URLs still undergo Safe

     * Browsing checks. If this is undesired, whitelist the URL with {@link

     * WebView#setSafeBrowsingWhitelist} or ignore the warning with {@link #onSafeBrowsingHit}.

     *

     * @param view The {@link android.webkit.WebView} that is requesting the

     *             resource.
@@ -176,13 +178,15 @@ public class WebViewClient { 
     * Notify the host application of a resource request and allow the

     * application to return the data.  If the return value is {@code null}, the WebView

     * will continue to load the resource as usual.  Otherwise, the return

     * response and data will be used.  NOTE: This method is called on a thread

     * response and data will be used.

     *

     * <p class="note"><b>Note:</b> This method is called on a thread

     * other than the UI thread so clients should exercise caution

     * when accessing private data or the view system.

     *

     * <p>Note: when Safe Browsing is enabled, these URLs still undergo Safe Browsing checks. If

     * this is undesired, whitelist the URL with {@link WebView#setSafeBrowsingWhitelist} or ignore

     * the warning with {@link #onSafeBrowsingHit}.

     * <p class="note"><b>Note:</b> When Safe Browsing is enabled, these URLs still undergo Safe

     * Browsing checks. If this is undesired, whitelist the URL with {@link

     * WebView#setSafeBrowsingWhitelist} or ignore the warning with {@link #onSafeBrowsingHit}.

     *

     * @param view The {@link android.webkit.WebView} that is requesting the

     *             resource.

core/java/android/webkit/WebViewLibraryLoader.java

+3 −1
Original line number Diff line number Diff line
@@ -204,7 +204,9 @@ class WebViewLibraryLoader { 


    /**

     * Load WebView's native library into the current process.

     * Note: assumes that we have waited for relro creation.

     *

     * <p class="note"><b>Note:</b> Assumes that we have waited for relro creation.

     *

     * @param clazzLoader class loader used to find the linker namespace to load the library into.

     * @param packageInfo the package from which WebView is loaded.

     */

core/java/android/webkit/WebViewProvider.java

+1 −1
Original line number Diff line number Diff line
@@ -316,7 +316,7 @@ public interface WebViewProvider { 
    /**

     * Provides mechanism for the name-sake methods declared in View and ViewGroup to be delegated

     * into the WebViewProvider instance.

     * NOTE For many of these methods, the WebView will provide a super.Foo() call before or after

     * NOTE: For many of these methods, the WebView will provide a super.Foo() call before or after

     * making the call into the provider instance. This is done for convenience in the common case

     * of maintaining backward compatibility. For remaining super class calls (e.g. where the

     * provider may need to only conditionally make the call based on some internal state) see the