Function: elisp-get-var-docstring

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

Signature

(elisp-get-var-docstring SYM)

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/elisp-mode.el.gz
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun elisp-get-var-docstring (sym)
  (cond ((not sym) nil)
        ((and (eq sym (aref elisp--eldoc-last-data 0))
              (eq 'variable (aref elisp--eldoc-last-data 2)))
         (aref elisp--eldoc-last-data 1))
        (t
         (let ((doc (documentation-property sym 'variable-documentation t)))
           (when doc
             (let ((doc (elisp--docstring-first-line doc)))
               (elisp--last-data-store sym doc 'variable)))))))