2 function-documentation.cc -- Scheme doc strings.
4 source file of the GNU LilyPond music typesetter
6 (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
12 #include "protected-scm.hh"
15 static Protected_scm doc_hash_table;
17 void ly_add_function_documentation (SCM func,
25 if (scm_hash_table_p (doc_hash_table) != SCM_BOOL_T)
26 doc_hash_table = scm_c_make_hash_table (59);
28 String s = String (" - ") + "LilyPond procedure: " + fname + " " + varlist
31 scm_set_procedure_property_x (func, ly_symbol2scm ("documentation"),
32 scm_makfrom0str (s.to_str0 ()));
33 SCM entry = scm_cons (scm_makfrom0str (varlist), scm_makfrom0str (doc));
34 scm_hashq_set_x (doc_hash_table, ly_symbol2scm (fname), entry);
37 LY_DEFINE (ly_get_all_function_documentation, "ly:get-all-function-documentation",
39 "Get a hash table with all lilypond Scheme extension functions.")
41 return doc_hash_table;