This is the mail archive of the
guile@sourceware.cygnus.com
mailing list for the Guile project.
Re: Doc Tasks (was RE: docstrings in Guile!)
- To: "Reynolds, Gregg" <greynolds at datalogics dot com>
- Subject: Re: Doc Tasks (was RE: docstrings in Guile!)
- From: "Greg J. Badros" <gjb at cs dot washington dot edu>
- Date: 16 Dec 1999 14:33:41 -0800
- Cc: Maciej Jennifer Stachowiak <mstachow at alum dot mit dot edu>, guile at sourceware dot cygnus dot com
- References: <51ED3F5356D8D011A0B1006097C3073401B17089@martinique>
"Reynolds, Gregg" <greynolds@datalogics.com> writes:
<snip>
> File-level documentation etc. It didn't take all that long to figure out
> how the docstrings mechanism works, but then I do a fair amount of shell
> programming and stuff. If I write up some notes on how it all fits together
> would I be wasting my time, or is that something appropriate for file-level
> docstrings? No reason your docstrings strategy couldn't be used to snarf
> chunks of doco in c comments, like
This'd be fine if you want to try to document the snarfing stuff (I was
going to, but have lots of other stuff to do, too). We can also
integrate pure SGML DocBook files into the manual-- for now lets just
get the docs in, e.g., doc/guile-snarf.sgml.
Greg