guile-user
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: auto documentation of new procedures?


From: Thien-Thi Nguyen
Subject: Re: auto documentation of new procedures?
Date: Sat, 14 Dec 2002 16:25:02 -0800

   From: first last <address@hidden>
   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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]