slime-autodoc-mode (SLIME User Manual, version 2.24)

Next: ASDF, Previous: Fuzzy Completion, Up: Contributed Packages [Contents][Index]

### 8.7 `slime-autodoc-mode`

Autodoc mode is an additional minor-mode for automatically showing information about symbols near the point. For function names the argument list is displayed, and for global variables, the value. Autodoc is implemented by means of `eldoc-mode` of Emacs.

The mode can be enabled by default in your `~/.emacs`:

    (add-to-list 'slime-contribs 'slime-autodoc)

`M-x slime-arglist NAME` ¶

  Show the argument list of the function NAME.

`M-x slime-autodoc-mode` ¶

  Toggles autodoc-mode on or off according to the argument, and toggles the mode when invoked without argument.

`C-c C-d a` ¶
`M-x slime-autodoc-manually`

  Like slime-autodoc, but when called twice, or after slime-autodoc was already automatically called, display multiline arglist.

If the variable `slime-use-autodoc-mode` is set (default), Emacs starts a timer, otherwise the information is only displayed after pressing SPC.

If `slime-autodoc-use-multiline-p` is set to non-nil, allow long autodoc messages to resize echo area display.

`slime-autodoc-mode-string` is a string that will be displayed in the mode line when autodoc-mode is enabled, or nil, if you prefer no indication. You can customize this variable.