Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

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 of the system itself and its local dependencies (other systems in the same distribution): components (modules and files), packages and 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. From there it is possible to produce readable / printable output in Info, HTML, PDF, PostScript, etc.

The primary example of documentation generated by Declt is (reference)The Declt Reference Manual.