summaryrefslogtreecommitdiff
path: root/core/src/main/java
diff options
context:
space:
mode:
authororelogo <orelogo@gmail.com>2016-07-18 01:10:31 -0400
committerorelogo <orelogo@gmail.com>2016-07-18 01:10:31 -0400
commit16e640ab1af3e1a194263910e5594840b5ec3bce (patch)
tree06ae1a060df61225273976caa79a5bef414fe4ad /core/src/main/java
parentb4b51e6e5808ccc443032fbd309854b33363dd1b (diff)
downloadAntennaPod-16e640ab1af3e1a194263910e5594840b5ec3bce.zip
Search Results: Clarify documentation and strings`
Diffstat (limited to 'core/src/main/java')
-rw-r--r--core/src/main/java/de/danoeh/antennapod/core/storage/FeedSearcher.java10
1 files changed, 9 insertions, 1 deletions
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) {