This is the trivial-documentation Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:55:43 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-documentationExtract documentation and definitions for symbols and packages.
Max Rottenkolber <max@mr.gy>
GNU AGPL
closer-mop (system).
sb-introspect (system).
extract.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-documentation/trivial-documentation.asdtrivial-documentation (system).
trivial-documentation/extract.lisptrivial-documentation (system).
package-api (function).
symbol-definitions (function).
class-definition (function).
class-precedence-list (function).
class-slot-initargs (function).
class-slots (function).
function-definition (function).
function-p (function).
generic-function-p (function).
lambda-list (function).
macro-function-p (function).
make-definition (function).
normalize-lambda-list (function).
symbol-name-< (function).
type-definition (function).
variable-definition (function).
Packages are listed by definition order.
trivial-documentationExtract documentation and definitions for symbols and packages.
common-lisp.
package-api (function).
symbol-definitions (function).
class-definition (function).
class-precedence-list (function).
class-slot-initargs (function).
class-slots (function).
function-definition (function).
function-p (function).
generic-function-p (function).
lambda-list (function).
macro-function-p (function).
make-definition (function).
normalize-lambda-list (function).
symbol-name-< (function).
type-definition (function).
variable-definition (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
*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).
*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 three additional _properties_ {:precedence-list}, {:initargs}, and {:slots} which hold the class precedence list, initialization arguments, and a _plist_ of _slot_ names and documentation strings of the class.
Compile definition for CLASS-NAME.
Get class precedence list for CLASS-NAME.
Get class slot initargs for CLASS-NAME.
Get plist of slot names and docstrings for CLASS-NAME.
Compile definition for FUNCTION-NAME.
Tests if FUNCTION-NAME is bound to a function.
Tests if FUNCTION-NAME is bound to a generic function.
Get lambda list for FUNCTION-NAME.
Tests if FUNCTION-NAME is bound to a macro function.
Base definition constructor. Prepend PLIST with :KIND property of value KIND.
Flatten symbols with default values.
Predicate to test if symbol names of SYMBOL-X and SYMBOL-Y satisfy STRING<.
Compile definition for TYPE-NAME.
Compile definition for VARIABLE.
| Jump to: | C F G L M N P S T V |
|---|
| Jump to: | C F G L M N P S T V |
|---|
| Jump to: | E F P S T |
|---|
| Jump to: | E F P S T |
|---|