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 display results of eldoc-documentation-functions.
This variable controls how to call the functions in the special hook
eldoc-documentation-functions, and how to organize their results
for display to the user. The functions in eldoc-documentation-functions
are the source of documentation, and act as back-end for ElDoc.
The following values are supported:
- eldoc-documentation-default: Call functions in the special
hook in order, until one of them returns a non-nil string
value. Display only that string.
- eldoc-documentation-compose: Call all the functions in the
special hook and display all of the resulting strings together,
after all of the functions were called, and in the order of the
functions in the hook.
- eldoc-documentation-compose-eagerly: Call all the functions in
the special hook, and display each non-nil string as soon as it
is returned by a function, before calling the next function.
- eldoc-documentation-enthusiast: Call all the functions in the
special hook, and display only the most important resulting
string at any given time. A function appearing first in
the special hook is considered more important than those which
appear after it.
This variable can also be set to a function of no arguments 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 display the resulting doc
strings itself.
For backward compatibility with 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.