bkyk8rc3zvpnsf5inmcqq4n3k98cv6hj-my-site-hyper-literate-git.test.suzanne.soy-0.0.1

commit dca3b2a8d4c19d40e26dd9a0f7f33a571293ba26
parent 7eef06ec0d22263278158a5ae41e3bd80b236a15
Author: Matthew Flatt <mflatt@racket-lang.org>
Date:   Tue, 23 Apr 2002 21:45:55 +0000

.

original commit: 7b3293975bf54a591ebc925238bc997501b30c60

Diffstat:
M
collects/help/private/search.ss
 | 
23
++++++++++++++---------

1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/collects/help/private/search.ss b/collects/help/private/search.ss
@@ -276,15 +276,20 @@
                        rest)))]
             [else (build-path path url-path)])))
       
-      ; do-search : ((? -> ?)
-      ;              ??
-      ;              boolean
-      ;              boolean
-      ;              ??
-      ;              (-> A) ; doesn't return
-      ;              (?? -> ??)
-      ;              (?? -> ??)
-      ;              (?? ?? ?? ?? ?? ?? -> ??)
+      ; do-search : (string       ; the search text, unprocessed
+      ;              num          ; 0 = keyword, 1 = keyword+index, 2 = all text
+      ;              boolean      ; #t if string should be used as a regexp
+      ;              boolean      ; #t if the string should match exactly (not just "contains")
+      ;              value        ; arbitrary key supplied to the "add" functions
+      ;              (-> A)       ; called when more than enough are found; must escape
+      ;              (string value -> void) ; called to output a document section header (e.g., a manual name)
+      ;              (symbol value -> void) ; called to output a document-kind section header, 'text or 'html
+      ;              (string string string string (union string #f) value -> void)
+      ;                ^       ^      ^     ^       ^- label within page
+      ;                ^       ^      ^     ^- path to doc page
+      ;                ^       ^      ^- source doc title
+      ;                ^       ^- display label
+      ;                ^- found entry's key 
       ;              ->
       ;              (union string #f))
       (define (do-search given-find search-level regexp? exact? ckey maxxed-out