File: eldoc.el.html
This program was inspired by the behavior of the "mouse documentation window" on many Lisp Machine systems; as you type a function's symbol name as part of a sexp, it will print the argument list for that function. Behavior is not identical; for example, you need not actually type the function name, you need only move point around in a sexp that calls it. Also, if point is over a documented variable, it will print the one-line documentation for that variable instead, to remind you of that variable's meaning.
This mode is now enabled by default in all major modes that provide
support for it, such as emacs-lisp-mode.
This is controlled by global-eldoc-mode(var)/global-eldoc-mode(fun).
Major modes for other languages may use ElDoc by adding an
appropriate function to the buffer-local value of
eldoc-documentation-functions.
Defined variables (27)
eldoc--doc-buffer | Buffer displaying latest ElDoc-produced docs. |
eldoc--enthusiasm-curbing-timer | Timer used by the ‘eldoc-documentation-enthusiast’ strategy. |
eldoc--last-request-state | Tuple containing information about last ElDoc request. |
eldoc--make-callback | Helper for function ‘eldoc--make-callback’. |
eldoc-argument-case | Case to display argument names of functions, as a symbol. |
eldoc-current-idle-delay | Idle time delay currently in use by timer. |
eldoc-display-functions | Hook of functions tasked with displaying ElDoc results. |
eldoc-doc-buffer-separator | String used to separate items in Eldoc documentation buffer. |
eldoc-documentation-function | How to collect and display results of ‘eldoc-documentation-functions’. |
eldoc-documentation-functions | Hook of functions that produce doc strings. |
eldoc-documentation-strategy | How to collect and display results of ‘eldoc-documentation-functions’. |
eldoc-echo-area-display-truncation-message | If non-nil, provide verbose help when a message has been truncated. |
eldoc-echo-area-prefer-doc-buffer | Prefer ElDoc’s documentation buffer if it is displayed in some window. |
eldoc-echo-area-use-multiline-p | Allow long ElDoc doc strings to resize echo area display. |
eldoc-help-at-pt | If non-nil, show ‘help-at-pt-kbd-string’ at point via Eldoc. |
eldoc-idle-delay | Number of seconds of idle time to wait before displaying documentation. |
eldoc-last-data | Bookkeeping; elements are as follows: |
eldoc-message-commands | Commands after which it is appropriate to print in the echo area. |
eldoc-message-commands-table-size | Used by ‘eldoc-add-command’ to initialize ‘eldoc-message-commands’ obarray. |
eldoc-message-function | The function used by ‘eldoc--message’ to display messages. |
eldoc-minor-mode-string | String to display in mode line when ElDoc Mode is enabled; nil for none. |
eldoc-mode | Non-nil if Eldoc mode is enabled. |
eldoc-mode-hook | Hook run after entering or leaving ‘eldoc-mode’. |
eldoc-print-after-edit | If non-nil, eldoc info is only shown after editing commands. |
eldoc-timer | ElDoc’s timer object. |
global-eldoc-mode | Non-nil if Global Eldoc mode is enabled. |
global-eldoc-mode-hook | Hook run after entering or leaving ‘global-eldoc-mode’. |
Defined functions (35)
Defined faces (1)
eldoc-highlight-function-argument | Face used for the argument at point in a function’s argument list. Note that this face has no effect unless the ‘eldoc-documentation-strategy’ handles it explicitly. |