Variable: eldoc-display-functions

eldoc-display-functions is a variable defined in eldoc.el.gz.

Value

(eldoc-display-in-echo-area
 eldoc-display-in-buffer)

Documentation

Hook of functions tasked with displaying ElDoc results.

Each function is passed two arguments: DOCS and INTERACTIVE. DOCS is a list (DOC ...) where DOC looks like (STRING :KEY VALUE :KEY2 VALUE2 ...). STRING is a string containing the documentation's text and the remainder of DOC is an optional list of keyword-value pairs denoting additional properties of that documentation. For commonly recognized properties, see eldoc-documentation-functions.

INTERACTIVE says if the request to display doc strings came directly from the user or from ElDoc's automatic mechanisms'.

The display functions always run in the source buffer which initiated the documentation request. If the source buffer is killed, the display functions just won't run.

Probably introduced at or before Emacs version 28.1.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/eldoc.el.gz
(defvar eldoc-display-functions
  '(eldoc-display-in-echo-area eldoc-display-in-buffer)
  "Hook of functions tasked with displaying ElDoc results.
Each function is passed two arguments: DOCS and INTERACTIVE.  DOCS
is a list (DOC ...) where DOC looks like (STRING :KEY VALUE :KEY2
VALUE2 ...).  STRING is a string containing the documentation's
text and the remainder of DOC is an optional list of
keyword-value pairs denoting additional properties of that
documentation.  For commonly recognized properties, see
`eldoc-documentation-functions'.

INTERACTIVE says if the request to display doc strings came
directly from the user or from ElDoc's automatic mechanisms'.

The display functions always run in the source buffer which initiated
the documentation request.  If the source buffer is killed, the display
functions just won't run.")