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

Update README for new minor mode

Browse Source
This commit is contained in:
Yuan Fu 2018-12-20 21:58:48 -05:00
parent 28eb1d7f8a
commit 615e8bce86
No known key found for this signature in database
GPG Key ID: 1CF5ECABEC37A901
1 changed files with 1 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.org
View File

@ -12,6 +12,7 @@ Get the file, add to load path, and
* Usage * Usage
** Function ** Function
- =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.
- =eldoc-box-hover-at-point-mode= :: This minor mode shows doc at point. Don't try to enable both minor mode: you can only enable one in the same time.
** Face ** 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.
@ -20,12 +21,6 @@ Get the file, add to load path, and
- =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.
- =eldoc-box-cleanup-interval= :: After this amount of seconds will eldoc-box attempt to cleanup the childframe. E.g. if it is set to 1, the childframe is cleared 1 second after you moved the point to somewhere else (that doesn't have a doc to show). - =eldoc-box-cleanup-interval= :: After this amount of seconds will eldoc-box attempt to cleanup the childframe. E.g. if it is set to 1, the childframe is cleared 1 second after you moved the point to somewhere else (that doesn't have a doc to show).
** Pop at point instead of on the upper corner
I don't use this, but if you do:
1. set =eldoc-box-position-function= to =eldoc-box--default-at-point-position-function=.
2. Set =eldoc-box-clear-with-C-g= to =t=, so =C-g= will clear the childframe.
3. Maybe set =eldoc-box-max-pixel-width= & =eldoc-box-max-pixel-height= to some custom functions.
** Use with eglot ** Use with eglot
As of writing this README, eglot doesn't have a public mode hook, use this hook: As of writing this README, eglot doesn't have a public mode hook, use this hook:
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp