JavaDoc for SearchableInfo.getActivityMetaData()

See http://b/editIssue?id=1968025

1 files changed, 8 insertions, 0 deletions

diff --git a/core/java/android/server/search/SearchableInfo.java b/core/java/android/server/search/SearchableInfo.java
index 283555a9dc40..045b0c2f0874 100644
--- a/core/java/android/server/search/SearchableInfo.java
+++ b/core/java/android/server/search/SearchableInfo.java
@@ -442,6 +442,14 @@ public final class SearchableInfo implements Parcelable {
         mActionKeys.put(keyInfo.getKeyCode(), keyInfo);
     }
 
+    /**
+     * Gets search information for the given activity.
+     *
+     * @param context Context to use for reading activity resources.
+     * @param activityInfo Activity to get search information from.
+     * @return Search information about the given activity, or {@code null} if
+     *         the activity has no or invalid searchability meta-data.
+     */
     public static SearchableInfo getActivityMetaData(Context context, ActivityInfo activityInfo) {
         // for each component, try to find metadata
         XmlResourceParser xml =