From 16e640ab1af3e1a194263910e5594840b5ec3bce Mon Sep 17 00:00:00 2001
From: orelogo <orelogo@gmail.com>
Date: Mon, 18 Jul 2016 01:10:31 -0400
Subject: Search Results: Clarify documentation and strings`

---
 .../java/de/danoeh/antennapod/core/storage/FeedSearcher.java   | 10 +++++++++-
 core/src/main/res/values/strings.xml                           |  4 ++--
 2 files changed, 11 insertions(+), 3 deletions(-)

(limited to 'core/src')

diff --git a/core/src/main/java/de/danoeh/antennapod/core/storage/FeedSearcher.java b/core/src/main/java/de/danoeh/antennapod/core/storage/FeedSearcher.java
index 7be851944..9d136273c 100644
--- a/core/src/main/java/de/danoeh/antennapod/core/storage/FeedSearcher.java
+++ b/core/src/main/java/de/danoeh/antennapod/core/storage/FeedSearcher.java
@@ -21,7 +21,15 @@ public class FeedSearcher {
 
 
     /**
-     * Performs a search in all feeds or one specific feed.
+     * Search through a feed, or all feeds, for episodes that match the query in either the title,
+     * chapter, or show notes. The search is first performed on titles, then chapters, and finally
+     * show notes. The list of resulting episodes also describes where the first match occurred
+     * (title, chapters, or show notes).
+     *
+     * @param context
+     * @param query search query
+     * @param selectedFeed feed to search, 0 to search through all feeds
+     * @return list of episodes containing the query
      */
     public static List<SearchResult> performSearch(final Context context,
                                                    final String query, final long selectedFeed) {
diff --git a/core/src/main/res/values/strings.xml b/core/src/main/res/values/strings.xml
index d0c2bd8e2..a029b190d 100644
--- a/core/src/main/res/values/strings.xml
+++ b/core/src/main/res/values/strings.xml
@@ -415,8 +415,8 @@
     <string name="auto_flattr_ater_end">Flattr episode when playback ends</string>
 
     <!-- Search -->
-    <string name="search_hint">Search for Feeds or Episodes</string>
-    <string name="found_in_shownotes_label">Found in shownotes</string>
+    <string name="search_hint">Search for episodes</string>
+    <string name="found_in_shownotes_label">Found in show notes</string>
     <string name="found_in_chapters_label">Found in chapters</string>
     <string name="search_status_no_results">No results were found</string>
     <string name="search_label">Search</string>
-- 
cgit v1.2.3