3693-mc_search_run-document-the-return-value.patch

From c796186befaf47a11f27c37bb4bd1349c9e0338c Mon Sep 17 00:00:00 2001
From: Mooffie <mooffie@gmail.com>
Date: Thu, 10 Nov 2016 22:26:54 +0200
Subject: [PATCH] (mc_search_run): document the return value.

---
 lib/search/search.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/lib/search/search.c b/lib/search/search.c
index 88008ab..2e19ccf 100644
--- a/lib/search/search.c
+++ b/lib/search/search.c
@@ -263,6 +263,19 @@ mc_search_prepare (mc_search_t * lc_mc_search)
 
 /* --------------------------------------------------------------------------------------------- */
 
+/**
+ * Carries out the search.
+ *
+ * Returns TRUE if found.
+ *
+ * Returns FALSE if not found. In this case, lc_mc_search->error reveals
+ * the reason:
+ *
+ *   - MC_SEARCH_E_NOTFOUND: the pattern isn't in the subject string.
+ *   - MC_SEARCH_E_ABORT: the user aborted the search.
+ *   - For any other reason (but not for the above two!): the description
+ *     is in lc_mc_search->error_str.
+ */
 gboolean
 mc_search_run (mc_search_t * lc_mc_search, const void *user_data,
                gsize start_search, gsize end_search, gsize * found_len)
-- 
2.9.3