Commit a4f390d5 a4f390d50778f940c321e6b289260a5f8b1f7939 by Sergey Poznyakoff

Documented some obscure data structures.

1 parent 63da744b
...@@ -373,6 +373,7 @@ ...@@ -373,6 +373,7 @@
373 373
374 ;;;; Comparators 374 ;;;; Comparators
375 375
376 ;;; Each entry is (list COMP-NAME COMP-FUNCTION)
376 (define sieve-comparator-table '()) 377 (define sieve-comparator-table '())
377 378
378 (define (sieve-find-comparator name) 379 (define (sieve-find-comparator name)
...@@ -391,7 +392,13 @@ ...@@ -391,7 +392,13 @@
391 392
392 ;;;; Command parsers 393 ;;;; Command parsers
393 394
394 395 ;;; Each entry is: (list NAME FUNCTION OPT-ARG-LIST REQ-ARG-LIST)
396 ;;; OPT-ARG-LIST is a list of optional arguments (aka keywords, tags).
397 ;;; It consists of conses: (cons TAG-NAME FLAG) where FLAG is #t
398 ;;; if the tag requires an argument (e.g. :comparator <comp-name>),
399 ;;; and is #f otherwise.
400 ;;; REQ-ARG-LIST is a list of required (positional) arguments. It
401 ;;; is a list of argument types.
395 (define sieve-test-table '()) 402 (define sieve-test-table '())
396 403
397 (define (sieve-find-test name) 404 (define (sieve-find-test name)
...@@ -650,6 +657,9 @@ ...@@ -650,6 +657,9 @@
650 (require-semicolon)) 657 (require-semicolon))
651 658
652 ;;; Actions 659 ;;; Actions
660
661 ;;; Each entry is: (list ACTION-NAME FUNCTION ARG-LIST)
662 ;;; ARG-LIST is a list of argument types
653 (define sieve-action-table '()) 663 (define sieve-action-table '())
654 664
655 (define (sieve-find-action name) 665 (define (sieve-find-action name)
......