Simple ElDoc frontend that displays documentation in a floating child frame
Go to file
Yuan Fu f0b1bd23c5
Fix: scroll/click doc frame make it disappear after 1s
- Add eldoc-box--last-point
- eldoc-box--display sets eldoc-box-hover-mode to t in doc buffer
- eldoc-box--maybe-cleanup checks more things to decide whether to
  clear frame
- eldoc-box--eldoc-message-function sets eldoc-box--last-point to
  (point)
2018-12-12 21:49:20 -05:00
eldoc-box.el Fix: scroll/click doc frame make it disappear after 1s 2018-12-12 21:49:20 -05:00
README.org Update readme 2018-12-11 11:17:17 -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-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)