document screen_find, make it return bool

diff --git a/src/screen_find.c b/src/screen_find.c
index 890f58cf14579dcf0436ec8012fa7f41437488e0..4113c39a522a1aef207c03540a60dac708ec25a1 100644 (file)
--- 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 1d46a9f8d4cfc01979100f66291fedb511e2e703..ff72012afd9720d69a638634a609964c49c9dc3d 100644 (file)
--- 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 */