jessieh/eldoc-frame
jessieh/eldoc-frame
1
Fork 0
Code Issues Pull Requests Releases Activity

Update readme

Browse Source
This commit is contained in:
Yuan Fu 2018-12-11 11:17:17 -05:00
parent 194ff4136a
commit 651e0810d7
No known key found for this signature in database
GPG Key ID: 1CF5ECABEC37A901
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.org
View File

@ -7,10 +7,13 @@ Get the file, add to load path, and
#+END_SRC #+END_SRC
* Usage * Usage
** Function
- =eldoc-box-help-at-point= :: Show the documentation of the symbol at point. - =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-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-border= :: Adjust =:background= of this face for border color.
- =eldoc-box-body= :: Adjust =:background= of this face for background color of childframe. - =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. - =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 ** Use with eglot