Re: [Gcl-devel] Documentation strings.

[C Y]

--- Camm Maguire <address@hidden> wrote:

> Mike this is a good idea, worthy of discussion.  Literate programming
> is great!  To my understanding, however, the standard lisp
> implementation/idea of docstrings is that they would reside in the
> running core. This would greatly enlarge our lisp image, even if the
> strings are compressed.  Then of course there is the issue of those
> wishing to read the docs outside of lisp, i.e. in a browser or info
> reader.  Perhaps we could write and store the docs inline in the
> source in this way, but export them from the core to external files
> as we do now.

Is the issue documenting the lisp code in GCL?  If so the albert doc
package might be of some interest?  http://albert.sf.net  I don't know
if it is appropriate for this application but it does have nice output.

I hope someday to expand the albert package somewhat so I can add
(albert-user-docstring "") and (albert-docstring "") distinctions, in
order to have both user and programmer level documentation in the
source code where appropriate.  It might also be fun to teach it to use
cl-pdf to directly generate pdf documentation :-).  Ah if only I had
the time.

CY


        
                
__________________________________
Do you Yahoo!?
New and Improved Yahoo! Mail - 100MB free storage!
http://promotions.yahoo.com/new_mail