Variable: eldoc-documentation-function
eldoc-documentation-function is an alias and customizable for
eldoc-documentation-strategy, defined in eldoc.el.gz.
Value
eldoc-documentation-default
Documentation
How to collect and organize results of eldoc-documentation-functions.
This variable controls how eldoc-documentation-functions, which
specifies the sources of documentation, is queried and how its
results are organized before being displayed to the user. The
following values are allowed:
- eldoc-documentation-default: calls functions in the special
hook in order until one is found that produces a doc string
value. Display only that value;
- eldoc-documentation-compose: calls all functions in the
special hook and displays all of the resulting doc strings
together. Wait for all strings to be ready, and preserve their
relative order as specified by the order of functions in the hook;
- eldoc-documentation-compose-eagerly: calls all functions in
the special hook and displays as many of the resulting doc
strings as possible, as soon as possible. Preserves the
relative order of doc strings;
- eldoc-documentation-enthusiast: calls all functions in the
special hook and displays only the most important resulting
docstring one at any given time. A function appearing first in
the special hook is considered more important.
This variable can also be set to a function of no args that
returns something other than a string or nil and allows for some
or all of the special hook eldoc-documentation-functions to be
run. In that case, the strategy function should follow that
other variable's protocol closely and endeavor to display the
resulting doc strings itself.
For backward compatibility to the "old" protocol, this variable can also be set to a function that returns nil or a doc string, depending whether or not there is documentation to display at all.
Probably introduced at or before Emacs version 22.1.