Function: global-eldoc-mode

global-eldoc-mode is an interactive and byte-compiled function defined in eldoc.el.gz.

Signature

(global-eldoc-mode &optional ARG)

Documentation

Toggle Eldoc mode in all buffers.

With prefix ARG, enable Global Eldoc mode if ARG is positive; otherwise, disable it.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

Eldoc mode is enabled in all buffers where turn-on-eldoc-mode would do it.

See eldoc-mode(var)/eldoc-mode(fun) for more information on Eldoc mode.

Probably introduced at or before Emacs version 25.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/eldoc.el.gz
;;;###autoload
(define-globalized-minor-mode global-eldoc-mode eldoc-mode turn-on-eldoc-mode
  :initialize 'custom-initialize-delay
  :init-value t
  ;; For `read--expression', the usual global mode mechanism of
  ;; `change-major-mode-hook' runs in the minibuffer before
  ;; `eldoc-documentation-strategy' is set, so `turn-on-eldoc-mode'
  ;; does nothing.  Configure and enable eldoc from
  ;; `eval-expression-minibuffer-setup-hook' instead.
  (if global-eldoc-mode
      (add-hook 'eval-expression-minibuffer-setup-hook
                #'eldoc--eval-expression-setup)
    (remove-hook 'eval-expression-minibuffer-setup-hook
                 #'eldoc--eval-expression-setup)))