eldoc-frame/README.org

• Install
• Usage
  • Function
  • Face
  • Variable
  • Use with eglot

This package displays ElDoc documentations in a childframe.

Install

Get the file, add to load path, and

(require 'eldoc-box)

Usage

Function

eldoc-box-help-at-point

Show the documentation of the symbol at point.

eldoc-box-hover-mode

Show documentation upon hover. Note that you need to enable ElDoc mode for this to work.

Face

eldoc-box-border

Adjust :background of this face for border color.

eldoc-box-body

Adjust :background of this face for background color of childframe.

Variable

eldoc-box-only-multi-line

Set this to non-nil and eldoc-box only display multi-line message in childframe. One line messages are left in minibuffer.

Use with eglot

As of writing this README, eglot doesn't have a public mode hook, use this hook:

(add-hook 'eglot--managed-mode-hook #'eldoc-box-hover-mode t)