[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: extract documentation from (define ...
|
From: |
sirgazil |
|
Subject: |
Re: extract documentation from (define ... |
|
Date: |
Sun, 01 Sep 2019 23:20:03 -0500 |
|
User-agent: |
Zoho Mail |
---- On Sun, 01 Sep 2019 16:45:23 -0500 Jesse Gibbons <address@hidden> wrote
----
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?
[0]: http://git.savannah.gnu.org/cgit/guile.git/tree/module/scripts/doc
-snarf.scm
I don't know of any program like that for Guile. I was looking for one myself
years ago, but couldn't find anything. However, you can extract procedure
documentation strings and other metadata using
https://www.gnu.org/software/guile/manual/html_node/Procedure-Properties.html.
And if you use texinfo for your documentation, take a look at
https://www.gnu.org/software/guile/manual/html_node/Texinfo-Processing.html.