Screenshots

eldoc-overlay

Eldoc displays the function signature of the closest function call around point either in the minibuffer or in the modeline. This package modifies Eldoc to display this documentation inline using a buffer text overlay.

eldoc-overlay-mode is a per-buffer minor mode.
A call to eldoc-overlay-enable turns it on.
A call to eldoc-overlay-disable turns it off

C-x C-h interactively calls eldoc-overlay-toggle and tells you the mode's new state.

global-eldoc-overlay-mode can be used to toggle this for all buffers.
A call to global-eldoc-overlay-enable turns it on.
A call to global-eldoc-overlay-disable turns it off

C-u C-x C-h interactively calls global-eldoc-overlay-toggle and tells you the mode's new state.

By default, the overlay is not used in the minibuffer, eldoc is shown in the modeline in this case. Set the option eldoc-overlay-in-minibuffer-flag non-nil if you want to enable overlay use in the minibuffer.

The key used to toggle the mode can be customized by setting the eldoc-overlay-key option.

Installation

(use-package eldoc-overlay
  :ensure t
  :init (eldoc-overlay-mode 1))

Configuration

An example config

(use-package eldoc-overlay
  :ensure t
  :delight eldoc-overlay-mode
  :custom ((eldoc-overlay-backend 'inline-docs)
           ;; (eldoc-overlay-delay 3)
           )
  :custom-face (inline-docs-border-face ((t (:family "DejaVu Sans Mono"))))
  :hook (eldoc-mode . eldoc-overlay-mode))

overlay display backend

Check out customize variable eldoc-overlay-backend.

overlay display delay

Check out customize variable eldoc-overlay-delay.

Usage

Eldoc displays the function signature of the closest function call around point either in the minibuffer or in the modeline.

This package modifies Eldoc to display this documentation inline using a buffer text overlay.

• eldoc-overlay-mode is a per-buffer minor mode.
• A call to `eldoc-overlay-enable' turns it on.
• A call to `eldoc-overlay-disable' turns it off

{C-x C-h} interactively calls `eldoc-overlay-toggle' and tells you the mode's new state.

• `global-eldoc-overlay-mode' can be used to toggle this for all buffers.
• A call to `global-eldoc-overlay-enable' turns it on.
• A call to `global-eldoc-overlay-disable' turns it off

{C-u C-x C-h} interactively calls global-eldoc-overlay-toggle and tells you the mode's new state.

By default, the overlay is not used in the minibuffer, eldoc is shown in the modeline in this case. Set the option eldoc-overlay-in-minibuffer-flag non-nil if you want to enable overlay use in the minibuffer.

The key used to toggle the mode can be customized by setting the eldoc-overlay-key option.

Finally, see the documentation for eldoc-overlay-backend if you want to try a different overlay display package backend.

Notices

• If you found the eldoc-overlay display border longer than window width, it's caused by the font of face inline-docs-border-face. You can fix this by setting face to use another mono font.

  (set-face-attribute 'inline-docs-border-face nil
                      :family "DejaVu Sans Mono")
  

Change log

break backward compatible upgrading changes

This source code originally came from an answer to justbur of this question.