From e5fc9a891a369d77eeeaa82162551f6a4ffc5fc5 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Tue, 7 May 2024 23:38:15 +0100
Subject: xapian: Document parse-query.

* xapian/xapian.scm (parse-query): Add docstring.
---
 xapian/xapian.scm | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'xapian')

diff --git a/xapian/xapian.scm b/xapian/xapian.scm
index d219c30..64042a2 100644
--- a/xapian/xapian.scm
+++ b/xapian/xapian.scm
@@ -178,6 +178,25 @@ generated."
                       (love-hate? #t)
                       any-case-boolean?
                       wildcard?)
+  "Parse @var{querystring} and return a @code{Query} object.
+
+@var{prefixes} and @var{boolean-prefixes} must be association lists
+mapping fields to prefixes or @code{FieldProcessor}
+objects. @var{range-processors} is a list of @code{RangeProcessor}
+objects.
+
+When @var{boolean?} is @code{#t}, boolean operators (AND, OR, etc.)
+and bracketed subexpressions are supported.
+
+When @var{phrases?} is @code{#t}, quoted phrases are supported.
+
+When @var{love-hate?} is @code{#t}, @samp{+} and @samp{-} are
+supported.
+
+When @var{any-case-boolean?} is @code{#t}, boolean operators are
+supported even if they are not in capitals.
+
+When @var{wildcard?} is @code{#t}, wildcards are supported."
   (let ((queryparser (new-QueryParser)))
     (QueryParser-set-stemmer queryparser stemmer)
     (when stemming-strategy
-- 
cgit v1.2.3