eldoc-frame

Simple ElDoc frontend that displays documentation in a floating child frame

Go to file

Yuan Fu 60f758a24a Speed up Originally I have (when str (display)), but that leaves childdrame unchanged. To work around that I added (eldoc-box-quit-frame). Now childframes are cleared up nicely but it lagging. (when (stringp str) (display)) works. (although I don't know why (when str) doesn't, even though eldoc-messaeg passes nil to message function)	2018-12-11 15:39:31 -05:00
eldoc-box.el	Speed up	2018-12-11 15:39:31 -05:00
README.org	Update readme	2018-12-11 11:17:17 -05:00

Originally I have (when str (display)), but that leaves childdrame
unchanged.
To work around that I added (eldoc-box-quit-frame).
Now childframes are cleared up nicely but it lagging.

(when (stringp str) (display)) works. (although I don't know why (when
str) doesn't, even though eldoc-messaeg passes nil to message function)

2018-12-11 15:39:31 -05:00

eldoc-box.el

Speed up

2018-12-11 15:39:31 -05:00

README.org

Update readme

2018-12-11 11:17:17 -05:00

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)