This is the mail archive of the guile@sourceware.cygnus.com mailing list for the Guile project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: Documentation proposal


Christian Lynbech <chl@tbit.dk> writes:

<snip>

> Michael> -- a texinfo version of the reference manual, with all
> Michael> functions described.  IMO this is much more valuable than
> Michael> docstrings, though of course the two aren't mutually
> Michael> exclusive.
> 
> One could generate a texinfo manual from docstrings and have both. I
> personally think that docstrings are pretty helpfull, but not
> everybody feels that way. SCWM does it slightly different I think
> (adding specially formatted comments to the code instead).
> 
> IMHO, this should be the top priority (autogenerating a reference
> manual from sources). 
> 
> This would involve devising a proposal of how to integrate docstrings
> into the source (comments or part of the definition, deciding how to
> integrate this with the C source), writing the extraction tools and
> integrating this into the build process. 
> 
> A side bonus to this process could be some way of getting online info
> on parameters to primitive functions.
> 
> Anyway, checking up on how SCWM does it would be a logical first step.

This is what Scwm does (though it builds sgml;  I'll leave writing a
TeXInfo generator in Guile for Guile as an exercise for someone else;
mine creates scwm.sgml using a Perl script).  I'm planning on making
Guile support extractable docstrings next weekend, if all goes well.

<snip>

Greg

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]