[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: extract documentation from (define ...
|
From: |
Mark H Weaver |
|
Subject: |
Re: extract documentation from (define ... |
|
Date: |
Wed, 04 Sep 2019 16:02:27 -0400 |
|
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) |
Hi Jesse,
Jesse Gibbons <address@hidden> 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?
>
> [0]: http://git.savannah.gnu.org/cgit/guile.git/tree/module/scripts/doc
> -snarf.scm
I would use 'object-documentation' procedure from (ice-9 documentation),
which is what underlies the ,describe REPL command.
Best,
Mark