From 6266e40a754d82afa717ef068898c8418a0bb5c3 Mon Sep 17 00:00:00 2001 From: Bjorn Bringert Date: Fri, 25 Sep 2009 14:25:41 +0100 Subject: [PATCH] Better JavaDoc for Activity.onSearchRequested(). Fixes http://b/issue?id=1248721 --- core/java/android/app/Activity.java | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/core/java/android/app/Activity.java b/core/java/android/app/Activity.java index f2905a7d80c5b..5e821fd93871a 100644 --- a/core/java/android/app/Activity.java +++ b/core/java/android/app/Activity.java @@ -2479,16 +2479,17 @@ public class Activity extends ContextThemeWrapper /** * This hook is called when the user signals the desire to start a search. * - *

You can use this function as a simple way to launch the search UI, in response to a - * menu item, search button, or other widgets within your activity. Unless overidden, - * calling this function is the same as calling: - *

The default implementation simply calls - * {@link #startSearch startSearch(null, false, null, false)}, launching a local search. + *

You can use this function as a simple way to launch the search UI, in response to a + * menu item, search button, or other widgets within your activity. Unless overidden, + * calling this function is the same as calling + * {@link #startSearch startSearch(null, false, null, false)}, which launches + * search for the current activity as specified in its manifest, see {@link SearchManager}. * *

You can override this function to force global search, e.g. in response to a dedicated * search key, or to block search entirely (by simply returning false). * - * @return Returns true if search launched, false if activity blocks it + * @return Returns {@code true} if search launched, and {@code false} if activity blocks it. + * The default implementation always returns {@code true}. * * @see android.app.SearchManager */