Function Entry: CLAUTOLISP-DOCUMENTATION-KIND

← Prev | ↑ Chapter | Next → | Index | Symbols

Function Entry: CLAUTOLISP-DOCUMENTATION-KIND

Name

clautolisp-documentation-kind

Class

Function

Syntax

(clautolisp-documentation-kind name)

Arguments and Values

  • name: a symbol or a string, as for clautolisp-documentation.

Description

Returns the kind of the documentation attached to name's innermost binding: the symbol function when the binding was last documented by a defun, the symbol variable when it was last documented by a setq, or nil when no documentation is recorded.

The kind reflects the most recent documented assignment, not the current value's runtime type. A binding documented by (defun foo …) reports function even after a subsequent bare (setq foo 42) only if the function-doc has not been cleared (i.e., another doc-block-bearing form re-documented it as a variable in between).

This builtin is the companion to clautolisp-documentation; tooling that pretty-prints documentation (such as alref-describe) uses both to render a Function: … or Variable: … prefix.

Return Values

The symbol function, the symbol variable, or nil.

Side Effects

None.

Examples

  • After ;| doc |; (defun foo () 1), (clautolisp-documentation-kind 'foo) returns function.
  • After ;| doc |; (setq bar 0), (clautolisp-documentation-kind 'bar) returns variable.
  • (clautolisp-documentation-kind 'no-such-binding) returns nil.

Availability

  • AutoCAD 2026: not documented.
  • BricsCAD V26: not documented.
  • clautolisp: implemented.
  • Status: clautolisp-only extension; companion to clautolisp-documentation.

Source Notes

  • No vendor reference. Specified by the source-aware-defun-documentation issue in this repository.