]> git.donarmstrong.com Git - lilypond.git/blob - scm/document-markup.scm
(allfiles): look for .ly rather
[lilypond.git] / scm / document-markup.scm
1 ;;;; document-markup.scm -- part of generated backend documentation
2 ;;;;
3 ;;;;  source file of the GNU LilyPond music typesetter
4 ;;;; 
5 ;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
7
8 (define (doc-markup-function func)
9   (let* ((doc-str  (procedure-documentation func))
10          (f-name (symbol->string (procedure-name  func)))
11          (c-name (regexp-substitute/global #f "-markup$" f-name  'pre "" 'post))
12          (sig (object-property func 'markup-signature))
13          (arg-names
14           (map symbol->string 
15                (cddr (cadr (procedure-source func)))))
16          
17          (sig-type-names (map type-name sig))
18          (signature (zip arg-names  sig-type-names))
19          (signature-str
20           (string-join
21            (map (lambda (x) (string-append
22                              "@var{" (car x) "} ("  (cadr x) ")" ))
23                 (zip arg-names  sig-type-names))
24            " " )))
25     
26     (string-append
27      "\n\n@item @code{\\" c-name "} " signature-str
28      
29      "\n@findex " f-name "\n"
30      "\n@cindex @code{" c-name "}\n"
31      
32      (if (string? doc-str)
33          doc-str
34          ""))))
35
36 (define (markup-function<? a b)
37   (string<? (symbol->string (procedure-name a)) (symbol->string (procedure-name b))))
38
39 (define (markup-doc-string)
40   (string-append
41    
42    "@table @asis"
43    (apply string-append
44           
45           (map doc-markup-function
46                (sort markup-function-list markup-function<?)))
47    "\n@end table"))
48
49 (define (markup-doc-node)
50   (make <texi-node>
51     #:name "Markup functions"
52     #:desc "Definitions of the markup functions."
53     #:text (markup-doc-string)))