Next: , Previous: , Up: Common Lisp Help System   [Contents][Index]


5.6.3 Documentation

The generic function DOCUMENTATION returns the documentation string associated with the given object if it is available; otherwise it returns ‘nil’. The DOCUMENTATION function gives you access to the programmer’s innermost thoughts.

The DOCUMENTATION function expects two arguments. The first is an object for which you wish to retrieve documentation, or a symbol naming that object. The second is a symbol designating the kind of documentation (there are several) you wish to retrieve.

variable

defvar, defparameter, defconstant

function

defun, defmacro, special forms

structure

defstruct

type

deftype

setf

defsetf

compiler-macro

define-compiler-macro

method-combination

define-method-combination