auto documentation of new procedures?

auto documentation of new procedures?

[first last]

I'm binding Guile to a C++ class library.  I'ld like
to be able to easily generate some documentation for
the users of the new Scheme interface to my library. 
Is there already a tool somewhere that 
turns the "gh_new_procedure*_*" and perhaps related
comments into reasonable Scheme documentation for the
functions defined?

The users already know how to use the C++ interface so
my  documentation is going to simply tell them what
each Guile function maps to in the C++ API. 



__________________________________________________
Do you Yahoo!?
Yahoo! Mail Plus - Powerful. Affordable. Sign up now.
http://mailplus.yahoo.com


_______________________________________________
Guile-user mailing list
Guile-user@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-user

Re: auto documentation of new procedures?

[Thien-Thi Nguyen]

   From: first last <oic2day@yahoo.com>
   Date: Mon, 9 Dec 2002 07:41:50 -0800 (PST)

   Is there already a tool somewhere that 
   turns the "gh_new_procedure*_*" and perhaps related
   comments into reasonable Scheme documentation for the
   functions defined?

guile-1.4.1.92 has (and uses for itself) such facilities:

  http://www.glug.org/alt/

you need to construct a template (.twerp) file wherein
instantiations of the docs can be placed arbitrarily.
this file is eventually converted to .texi format and
ultimately to .info (or whatever).  see node "Snarfing"
in the manaul for more info.  see doc/ref/ in the distro
for a "live" example.

in the cvs version of guile, documentation can also be
harvested from scheme macros (e.g., `begin-thread' in
ice-9/threads.scm).  i mention this because the change
from 1.4.1.92 involved extending @twerpFOO namespace, so
if there are any C++-related requirements, i would be
glad to find out about them in order to include proper
support in 1.4.1.93.

thi


_______________________________________________
Guile-user mailing list
Guile-user@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-user