Next: Assembly, Previous: Pipeline Usage, Up: Pipeline Usage [Contents][Index]
As mentioned before (see Overview), the first stage of the Declt pipeline, called the “assessment” stage, loads the library, and then introspects the Lisp environment in order to extract the pertinent information.
The assessment part of Declt is provided as a separate system called ‘net.didierverna.declt.assess’, which you may load individually (Declt’s main system depends on it). It also comes in a separate package called ‘net.didierverna.declt.assess’ (imported by Declt’s main package).
In order to assess a library, use the assess function.
Extract and return documentation information for ASDF
SYSTEM-NAME.
SYSTEM-NAME is an ASDF system designator.
The complete list of keyword arguments, also recognized by the global
Declt function, is described in Assessment Options. This
function returns an instance of the report class. The following
sections provide additional information on the assessment’s
operation, and some details on the report class.