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-20 22:19:58 -05:00
parent cf5ef5510c
commit c7fea8278e
No known key found for this signature in database
GPG Key ID: 1CF5ECABEC37A901
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.org
View File

@ -19,7 +19,7 @@ Get the file, add to load path, and
** Variable ** Variable
- =eldoc-box-max-pixel-width= & =eldoc-box-max-pixel-height= :: Set them according to the screen resolution of your machine. - =eldoc-box-max-pixel-width= & =eldoc-box-max-pixel-height= :: Set them according to the screen resolution of your machine.
- =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). This doesn't apply to =eldoc-box-hover-at-point-mode=, in that mode the childframe is cleared as soon as point moves.
** 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:

4
eldoc-box.el
View File

@ -57,7 +57,9 @@
(defvar eldoc-box-cleanup-interval 1 (defvar eldoc-box-cleanup-interval 1
"After this amount of seconds will eldoc-box attempt to cleanup the childframe. "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 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)") you moved the point to somewhere else (that doesn't have a doc to show).
This doesn't apply to =eldoc-box-hover-at-point-mode=,
in that mode the childframe is cleared as soon as point moves.")
(defvar eldoc-box-clear-with-C-g nil (defvar eldoc-box-clear-with-C-g nil
"If set to non-nil, eldoc-box clears cildframe when you hit \C-g.") "If set to non-nil, eldoc-box clears cildframe when you hit \C-g.")