eldoc-frame

Simple ElDoc frontend that displays documentation in a floating child frame

Go to file

Yuan Fu 388282f59f Clean up childframe after ElDoc Add cleanup function and a idle timer Why a timer? ElDoc is mainly use in minibuffer, where the text is constantly being flushed by other commands so ElDoc doesn't try very hard to cleanup		2018-12-12 00:14:53 -05:00
eldoc-box.el	Clean up childframe after ElDoc	2018-12-12 00:14:53 -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)

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.

eldoc-box-border: Adjust :background of this face for border color.
eldoc-box-body: Adjust :background of this face for background color of childframe.

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.

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)