TRIVIAL-DOCUMENTATION API DOCUMENTATION

                                                         Max Rottenkolber
                                                     Friday, 31 July 2015

Table of Contents

   1 trivial-documentation
     1.1 package-api (Function)
     1.2 symbol-definitions (Function)

1 trivial-documentation

   Extract documentation and definitions for symbols and packages.

1.1 package-api (Function)

   Syntax:

   — Function: package-api package

   Arguments and Values:

   package—a package or a string designator naming a package.

   Description:

   extract-api compiles and returns a property list mapping the external
   symbols of package to lists of definitions as returned by
   symbol-definitions. The returned property list is in alphabetical
   order (by comparing the keys).

1.2 symbol-definitions (Function)

   Syntax:

   — Function: symbol-definitions symbol

   Arguments and Values:

   symbol—a symbol.

   Description:

   symbol-definitions compiles and returns a list of definitions for
   symbol. Each definition is a property list containing at least two
   properties:

 * :kind—one of :constant, :variable, :function, :generic-function,
   :macro, :structure, :class or :type.

 * :documentation—the respective documentation string or nil.

   Definitions of kind :constant and :variable have an additional
   property :value which holds the initial value of the constant or
   variable.

   Definitions of kind :function, :generic-function and :macro have an
   additional property :lambda-list which holds the lambda list of the
   (generic) function or macro.

   Definitions of kind :class have two additional properties
   :precedence-list and :initargs which hold the class precedence list
   and initialization arguments of the class.