Function: elisp-eldoc-var-docstring

elisp-eldoc-var-docstring is a byte-compiled function defined in elisp-mode.el.gz.

Signature

(elisp-eldoc-var-docstring CALLBACK &rest IGNORED)

Documentation

Document variable at point.

Intended for eldoc-documentation-functions (which see).

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/elisp-mode.el.gz
(defun elisp-eldoc-var-docstring (callback &rest _ignored)
  "Document variable at point.
Intended for `eldoc-documentation-functions' (which see)."
  (let* ((sym (elisp--current-symbol))
         (docstring (and sym (elisp-get-var-docstring sym))))
    (when docstring
      (funcall callback docstring
               :thing sym
               :face 'font-lock-variable-name-face))))