I'm pleased to announce the release of Declt 1.0, the first officially
stable version[1].
Declt (pronounce "dec'let") is a reference manual generator for Common
Lisp libraries. It works by loading an ASDF system and introspecting
its contents. The generated documentation contains the description for
the system itself and its components (modules and files), the packages
defined in that system and the definitions found in those packages.
Exported and internal definitions are listed separately. This allows the
reader to have a quick view on the library's public API. Within each
section, definitions are sorted lexicographically.
In addition to ASDF system components and packages, Declt documents the
following definitions: constants, special variables, symbol macros,
macros, setf expanders, compiler macros, functions (including setf
ones), generic functions and methods (including setf ones), method
combinations, conditions, structures, classes and types.
The generated documentation includes every possible bit of information
that introspecting can provide: documentation strings, lambda lists
(including qualifiers and specializers where appropriate), slots
(including type, allocation and initialization arguments), definition
source file etc.
Every documented item provides a full set of cross-references to related
items: ASDF component dependencies, parents and children, classes direct
methods, super and subclasses, slot readers and writers, setf expanders
access and update functions etc.
Finally, Declt produces exhaustive and multiple-entry indexes for every
documented item.
Reference manuals are generated in Texinfo format (compatible, but not
requiring Texinfo 5). From there it is possible to produce readable /
printable output in info, HTML, PDF, DVI and PostScript with tools such
as makeinfo, texi2dvi or texi2pdf.
The Declt reference manual is the primary example of documentation
generated by Declt itself.
Footnotes:
[1]
http://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt
--
Resistance is futile. You will be jazzimilated.
Lisp, Jazz, Aïkido:
http://www.didierverna.info