|
| From: | Jan Nieuwenhuizen |
| Subject: | Re: extract documentation from (define ... |
| Date: | Mon, 02 Sep 2019 07:19:15 +0200 |
| User-agent: | Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) |
Jesse Gibbons writes:
> I am trying to generate documentation for a project written in guile. I
> tried "guild doc-snarf" [0] but apparently it only recognizes
> documentation in double-semicolon comments. A lot of the project is
> documented in a string like one would document an emacs-lisp function.
> Is there a program to extract that kind of documentation?
For Emacsy[0] I have used a guild doc-snarf but am now switching to doc
strings using. See the `wip-doc' branch and esp.
https://git.savannah.nongnu.org/cgit/emacsy.git/tree/scripts/document-module.scm?h=wip-doc
You may want to look at the Makefile.am as well for how it's used.
HTH,
janneke
[0] https://savannah.nongnu.org/projects/emacsy
--
Jan Nieuwenhuizen <address@hidden> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | Avatar® http://AvatarAcademy.com
| [Prev in Thread] | Current Thread | [Next in Thread] |