Package: liber

Function liber:extract-documentation

Lambda List

liber:extract-documentation (packages directory &rest keys &key include-slot-definitions-p include-internal-symbols-p &allow-other-keys)

Arguments

packages -- list of package designators, documentation will be generated for these packages
directory -- a pathname specifying a directory, the output file will be written to this directory, which must already exist
include-slot-definitions-p -- a boolean
keys -- extra parameters for stylesheets

Details

Extracts docstrings from packages and writes them in XML syntax to .atdoc.xml in the specified directory. With include-slot-definitions-p, class documentation will include a list of direct slots.

Extra parameters will be inserted as attributes on the root element.
 

See also

2025-09-06