User Tools


Standard Generic Function DOCUMENTATION, (SETF DOCUMENTATION)

Syntax

  • documentation x doc-typedocumentation
  • (setf documentation) new-value x doc-typenew-value

Argument Precedence Order

doc-type, object

Method Signatures

Functions, Macros, and Special Forms

Method Combinations

Methods

Packages

  • documentation (x package) (doc-type (eql 't))
  • (setf documentation) new-value (x package) (doc-type (eql 't))

Types, Classes, and Structure Names

Variables


Arguments and Values

Description

The generic function documentation returns the documentation string associated with the given object if it is available; otherwise it returns nil.

The generic function (setf documentation) updates the documentation string associated with x to new-value. If x is a list, it must be of the form (setf symbol).

Documentation strings are made available for debugging purposes. Conforming programs are permitted to use documentation strings when they are present, but should not depend for their correct behavior on the presence of those documentation strings. An implementation is permitted to discard documentation strings at any time for implementation-defined reasons.

The nature of the documentation string returned depends on the doc-type, as follows:

compiler-macro

Returns the documentation string of the compiler macro whose name is the function name x.

function

If x is a function name, returns the documentation string of the function, macro, or special operator whose name is x.

If x is a function, returns the documentation string associated with x.

method-combination

If x is a symbol, returns the documentation string of the method combination whose name is x.

If x is a method combination, returns the documentation string associated with x.

setf

Returns the documentation string of the setf expander whose name is the symbol x.

structure

Returns the documentation string associated with the structure name x.

t

Returns a documentation string specialized on the class of the argument x itself. For example, if x is a function, the documentation string associated with the function x is returned.

type

If x is a symbol, returns the documentation string of the class whose name is the symbol x, if there is such a class. Otherwise, it returns the documentation string of the type which is the type specifier symbol x.

If x is a structure class or standard class, returns the documentation string associated with the class x.

variable

Returns the documentation string of the dynamic variable or constant variable whose name is the symbol x.


A conforming implementation or a conforming program may extend the set of symbols that are acceptable as the doc-type.

Examples

None.

Affected By

None.

Exceptional Situations

None.

See Also

None.

Notes

This standard prescribes no means to retrieve the documentation strings for individual slots specified in a defclass form, but implementations might still provide debugging tools and/or programming language extensions which manipulate this information. Implementors wishing to provide such support are encouraged to consult the Metaobject Protocol for suggestions about how this might be done.

\issue{DOCUMENTATION-FUNCTION-BUGS:FIX} \issue{DOCUMENTATION-FUNCTION-BUGS:FIX} \issue{DOCUMENTATION-FUNCTION-BUGS:FIX} \issue{DOCUMENTATION-FUNCTION-BUGS:FIX} \issue{SETF-METHOD-VS-SETF-METHOD:RENAME-OLD-TERMS}