Simple ElDoc frontend that displays documentation in a floating child frame
Go to file
Yuan Fu aec39b6bd4
Remove eldoc-box-help-at-point
This function doesn't play well when eldoc-document-function is async.
Plus this function is not in ElDoc spec anyway.
2018-12-14 18:03:51 -05:00
eldoc-box.el Remove eldoc-box-help-at-point 2018-12-14 18:03:51 -05:00
README.org Remove eldoc-box-help-at-point 2018-12-14 18:03:51 -05:00

This package displays ElDoc documentations in a childframe.

Install

Get the file, add to load path, and

(require 'eldoc-box)

Usage

Function

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-max-pixel-width & eldoc-box-max-pixel-height
Set them according to the screen resolution of your machine.
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)