diff options
| author | Chong Yidong <cyd@gnu.org> | 2011-10-19 20:26:14 -0400 |
|---|---|---|
| committer | Chong Yidong <cyd@gnu.org> | 2011-10-19 20:26:14 -0400 |
| commit | ac6c8639bdb115cf57c65a383b4564aa98505389 (patch) | |
| tree | 7271460be2206ea711f46b06e895b6b701976769 /lisp/progmodes/which-func.el | |
| parent | aa42ab43f2e3ea06adb21f82abb3d4c502bc9d40 (diff) | |
| download | emacs-ac6c8639bdb115cf57c65a383b4564aa98505389.tar.gz | |
Fix more minor mode docstrings.
* lisp/emulation/cua-base.el (cua-mode):
* lisp/mail/footnote.el (footnote-mode):
* lisp/mail/mailabbrev.el (mail-abbrevs-mode):
* lisp/net/xesam.el (xesam-minor-mode):
* lisp/progmodes/bug-reference.el (bug-reference-mode):
* lisp/progmodes/cap-words.el (capitalized-words-mode):
* lisp/progmodes/compile.el (compilation-minor-mode)
(compilation-shell-minor-mode):
* lisp/progmodes/gud.el (gud-tooltip-mode):
* lisp/progmodes/hideif.el (hide-ifdef-mode):
* lisp/progmodes/idlw-shell.el (idlwave-shell-electric-debug-mode):
* lisp/progmodes/subword.el (subword-mode):
* lisp/progmodes/vhdl-mode.el (vhdl-electric-mode, vhdl-stutter-mode):
* lisp/progmodes/which-func.el (which-function-mode):
* lisp/term/tvi970.el (tvi970-set-keypad-mode):
* lisp/term/vt100.el (vt100-wide-mode):
* lisp/textmodes/flyspell.el (flyspell-mode):
* lisp/textmodes/ispell.el (ispell-minor-mode):
* lisp/textmodes/nroff-mode.el (nroff-electric-mode):
* lisp/textmodes/paragraphs.el (use-hard-newlines):
* lisp/textmodes/refill.el (refill-mode):
* lisp/textmodes/reftex.el (reftex-mode):
* lisp/textmodes/rst.el (rst-minor-mode):
* lisp/textmodes/sgml-mode.el (html-autoview-mode)
(sgml-electric-tag-pair-mode):
* lisp/textmodes/tex-mode.el (latex-electric-env-pair-mode):
* lisp/vc/diff-mode.el (diff-auto-refine-mode, diff-minor-mode):
* lisp/emulation/crisp.el (crisp-mode):
* lisp/emacs-lisp/eldoc.el (eldoc-mode):
* lisp/emacs-lisp/checkdoc.el (checkdoc-minor-mode): Doc fixes for new
minor mode behavior.
* lisp/erc/erc-fill.el (erc-fill-mode):
* lisp/erc/erc-track.el (erc-track-minor-mode): Doc fix.
* lisp/erc/erc.el (define-erc-module): Fix autogenerated docstring to
reflect Emacs 24 minor mode changes.
* lisp/gnus/gnus-cite.el (gnus-message-citation-mode): Doc fix (in Emacs 24,
calling a minor mode from Lisp with nil arg enables it, so we have to
make the working a bit ambiguous here).
Diffstat (limited to 'lisp/progmodes/which-func.el')
| -rw-r--r-- | lisp/progmodes/which-func.el | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/lisp/progmodes/which-func.el b/lisp/progmodes/which-func.el index 97e188139e9..e27d07854c8 100644 --- a/lisp/progmodes/which-func.el +++ b/lisp/progmodes/which-func.el @@ -236,12 +236,14 @@ It creates the Imenu index for the buffer, if necessary." ;; This is the name people would normally expect. ;;;###autoload (define-minor-mode which-function-mode - "Toggle Which Function mode, globally. -When Which Function mode is enabled, the current function name is -continuously displayed in the mode line, in certain major modes. - -With prefix ARG, turn Which Function mode on if arg is positive, -and off otherwise." + "Toggle mode line display of current function (Which Function mode). +With a prefix argument ARG, enable Which Function mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Which Function mode is a global minor mode. When enabled, the +current function name is continuously displayed in the mode line, +in certain major modes." :global t :group 'which-func (when (timerp which-func-update-timer) (cancel-timer which-func-update-timer)) |