From ccc71047bee191463d8dffa0fd28bfb32984613e Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jonathan=20Neusch=C3=A4fer?= Date: Mon, 26 Sep 2011 00:02:40 +0200 Subject: [PATCH] document screen_find, make it return bool --- src/screen_find.c | 2 +- src/screen_find.h | 18 +++++++++++++----- 2 files changed, 14 insertions(+), 6 deletions(-) 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 */ -- 2.30.2