aboutsummaryrefslogtreecommitdiff
path: root/module/scripts/find-undocumented.scm
diff options
context:
space:
mode:
Diffstat (limited to 'module/scripts/find-undocumented.scm')
-rw-r--r--module/scripts/find-undocumented.scm9
1 files changed, 9 insertions, 0 deletions
diff --git a/module/scripts/find-undocumented.scm b/module/scripts/find-undocumented.scm
index 127baa74..01dde818 100644
--- a/module/scripts/find-undocumented.scm
+++ b/module/scripts/find-undocumented.scm
@@ -16,6 +16,15 @@
;; (define %help "")
+;;; All texinfo forms we want to capture.
+;;; For each of these, the following grammar holds:
+;;; - The first element should be a string of the texinfo tag to match
+;;; - The following arguments are
+;;; - Any number of `_`, meaning an argument we don't care about
+;;; - a single instance of the symbol `name`, which indicates where the name of
+;;; the definition is stored.
+;;; - An optional final argument `...`, which indicates that more may argumnets
+;;; may follow.
(define texinfo-definition-forms
'(("deffn" _ name ...)
("deftp" _ name ...)