diff options
| author | Arun Isaac | 2024-05-07 23:38:15 +0100 |
|---|---|---|
| committer | Arun Isaac | 2024-05-07 23:48:24 +0100 |
| commit | e5fc9a891a369d77eeeaa82162551f6a4ffc5fc5 (patch) | |
| tree | 6449bf3950b1ade7f707cce250d051a15e62050c | |
| parent | 551f6bea36c0f3f4f44667998f29ebdd0c3bb1bf (diff) | |
| download | guile-xapian-e5fc9a891a369d77eeeaa82162551f6a4ffc5fc5.tar.gz guile-xapian-e5fc9a891a369d77eeeaa82162551f6a4ffc5fc5.tar.lz guile-xapian-e5fc9a891a369d77eeeaa82162551f6a4ffc5fc5.zip | |
xapian: Document parse-query.
* xapian/xapian.scm (parse-query): Add docstring.
| -rw-r--r-- | xapian/xapian.scm | 19 |
1 files changed, 19 insertions, 0 deletions
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 |