Dear all,
I'm working on a (new) guile-binding for mu[1]. I did it earlier around
~2013 or so, it's nice to see where Guile has changed (and where not)!
One thing I'm not quite sure about is how to document my Guile code.
What I want is:
1) document the code, preferable inline (i.e., emacs-style docstrings),
so I can get documentation interactively with ",d" etc.
2) from that, generate some texinfo that I can can include in the info
manual
I'm not quite sure if that is possible though:
- seems I can use emacs-style docstrings for procedures/methods, but
not for variables (e.g. (define foo 123) (or?)
- moreover, I cannot generate texinfo from these docstrings (or?)
If we're _not_ using docstrings but ";;-style" descriptions,
some options seem to be:
a) guild doc-snarf
- cannot find any documentation for this
- seems it misunderstands some variable-defines as procedures
- do we get ,d-style documentation as well?
b) (ice-9 documentation)
- it's a bit unclear if/how we can have ",d" documentation with this,
and/or texinfo. Can it?
Also:
c) https://codeberg.org/luis-felipe/guile-documenta
- looks promising
- this seems to use "docstring"-style comments (but with texinfo
markup, so wouldn't that look off with ",d"?
- obviously, it's not included with guile
For now, I'm using docstrings + manually writing the texinfo. But, can I
do better? Any suggestions welcome!
Thanks in advance,
Dirk.
[1] https://www.djcbsoftware.nl/code/mu/
--
Dirk-Jan C. Binnema Helsinki, Finland
e:[email protected] w:www.djcbsoftware.nl
gpg: 6987 9CED 1745 9375 0F14 DA98 11DD FEA9 DCC4 A036
