Function document

Package:

IT.UNIMIB.DISCO.MA.CL.HELambdaP

Syntax:

  document
        FOR-WHAT
        &KEY
        DOCUMENTATION-TITLE
        FORMAT
        LAYOUT
        SOURCE
        DESTINATION
        SUPERSEDE
        ONLY-DOCUMENTED
        ONLY-EXPORTED
        EVERYTHING
        EXCLUDE-DIRECTORIES
        EXCLUDE-FILES
        SPECIAL-METHODS-DEFS-FILES
        CLEAR-DOCUMENTATION-DB
        &ALLOW-OTHER-KEYSresult

Arguments and Values:

Description:

Produces the documentation for something.

The function is a wrapper for BUILD-DOCUMENTATION defaulting a few parameters, in particular the output FORMAT (which defaults to HTML).

Notes:

At the time of this writing, ASDF and MK-DEFSYSTEM are supported.

The arguments SOURCE and SUPERSEDE are, at the time of this writing, effectively ignored.

The argument SPECIAL-METHODS-DEFS-FILES is a list of Common Lisp files that will be loaded before running the documentation parsers; it is assumed that these files will contain mostly DEFINE-DOCUMENTATION-EXTRACTOR and EXTRACT-NAMED-FORM-DOCUMENTATION definitions. The loading of these files is wrapped in an IGNORE-ERRORS form: failure to load one of them will not completely hamper the documentation procedure.