From: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Date: Sun, 25 Sep 2011 22:02:40 +0000 (+0200)
Subject: document screen_find, make it return bool
X-Git-Tag: release-0.20~84
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=ccc71047bee191463d8dffa0fd28bfb32984613e;p=ncmpc.git

document screen_find, make it return bool
---

diff --git a/src/screen_find.c b/src/screen_find.c
index 890f58c..4113c39 100644
--- a/src/screen_find.c
+++ b/src/screen_find.c
@@ -30,7 +30,7 @@
 #define JUMP_PROMPT _("Jump")
 
 /* query user for a string and find it in a list window */
-int
+bool
 screen_find(struct list_window *lw, command_t findcmd,
 	    list_window_callback_fn_t callback_fn,
 	    void *callback_data)
diff --git a/src/screen_find.h b/src/screen_find.h
index 1d46a9f..ff72012 100644
--- a/src/screen_find.h
+++ b/src/screen_find.h
@@ -23,11 +23,19 @@
 #include "command.h"
 #include "list_window.h"
 
-/* query user for a string and find it in a list window */
-int screen_find(struct list_window *lw,
-		command_t findcmd,
-		list_window_callback_fn_t callback_fn,
-		void *callback_data);
+/**
+ * query user for a string and find it in a list window
+ *
+ * @param lw the list window to search
+ * @param findcmd the search command/mode
+ * @param callback_fn a function returning the text of a given line
+ * @param callback_data a pointer passed to callback_fn
+ * @return true if the command has been handled, false if not
+ */
+bool screen_find(struct list_window *lw,
+		 command_t findcmd,
+		 list_window_callback_fn_t callback_fn,
+		 void *callback_data);
 
 /* query user for a string and jump to the entry
  * which begins with this string while the users types */