On 17.01.2007, at 00:53, Justin Heyes-Jones wrote: > Yeah that's pretty good stuff. > > Do you know of anything that can create the list of functions and > constants along with the docstrings? That would be a good start.
The sbcl documentation builder does this, although the code is ugly (I wrote the original version, so I know) and somewhat sbcl- dependent. As far as I know, a variant can be found in McCLIM as Doc/ docstrings.lisp that might be a bit cleaner. What the code does is run through a list of packages and inspect the exported symbols, creating Texinfo documentation snippets for classes, structures, conditions, functions, variables and macros. Some lightweight heuristic formatting is applied to the docstrings, so e.g. parameter names are set in monospace. The resulting text looks a bit like the hyperspec or elisp manual function descriptions. What the code doesn't do is create whole chapters of documentation. Those who have to read through the typical JavaDoc API documents might see this as a feature. Instead, the manual writer inserts @include statements at chosen points in the main Texinfo documents. Examples of this system are the SBCL and McCLIM manuals. Cheers, Rudi _______________________________________________ application-builder mailing list [email protected] http://www.lispniks.com/mailman/listinfo/application-builder
