I'd suggest using noweb and do literate program documentation.

A version of noweb in common lisp could be included in the library.

We've discussed implementing a common lisp version of a literate
programming tool in the Axiom project (which is Modified BSD) so
the tool would be free and could be contributed. For an example
of literate source code in noweb see
http://wiki.axiom-developer.org/SandBoxPamphlet
which can be rendered as pdf, dvi, ps, src, latex, or html.
In addition it is possible to make the text hyperlinked so you
can look at the pdf or html and jump around. 

Literate coding has the key advantages that you are writing for people
and you are keeping the program in the documentation (which is a
subtle but vital difference from keeping the documentation in the code
ala JavaDoc).

Of course, as I always say "advocacy is volunteering" so I'll
contribute the lisp/noweb code when I get it done.



I have a function "tracefile" which reads a file and traces
every defun in the file as well as "traceload" which loads and
traces every defun. If you're interested I could clean these up
and submit them.



You might also consider structuring the library along the lines
of the Java library. The key advantage is that you already have
the architecture done (no comment regarding it's beauty) and the
problem is to fill in the parts (e.g. TCP, refection, SQL, GUI, etc)
The caveat is that we ban anyone who names a function 
org.lispniks.com.studlyCapsFunctionName. :-)

Tim 
_______________________________________________
Gardeners mailing list
[email protected]
http://www.lispniks.com/mailman/listinfo/gardeners

Reply via email to