[Gardeners] texinfo (was Re: CLX)
JC Helary
jch.helary at free.fr
Thu Jan 5 14:01:35 CST 2006
Ok, thank you for your answer.
JC
On 2006/01/06, at 4:34, Paolo Amoroso wrote:
> JC Helary <jch.helary at free.fr> writes:
>
>> Does that mean that Lisp applications are easier to document using
>> TexInfo ? Are there specific TexInfo tools that can extract
>> documentation from the lisp code to create the application
>> documentation for example ? Would you suggest TexInfo to be the
>> default documentation format for List applications ?
>
> I see. No, Texinfo is just a formatting language, it is not designed
> for extracting documentation from Lisp source code--or other sources,
> for that matter. I actually meant that the Texinfo formatting
> language provides a rich set of commands for describing many kinds of
> entities found in Lisp code such as DEFUNs, DEFMACROs, DEFVARs, etc.
>
> This information is usually inserted manually while editing a
> document. The SBCL developers, however, have tools for extracting
> information from source code and generating Texinfo-formatted files
> that are part of the user manual. See create-contrib-doc-list.lisp
> and docstrings.lisp in the doc/manual directory of the SBCL source
> tree.
>
>
> Paolo
> --
> Lisp Propulsion Laboratory log - http://www.paoloamoroso.it/log
> _______________________________________________
> Gardeners mailing list
> Gardeners at lispniks.com
> http://www.lispniks.com/mailman/listinfo/gardeners
>
More information about the Gardeners
mailing list