mirror of
git://git.sv.gnu.org/emacs.git
synced 2025-12-06 06:20:55 -08:00
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).
This commit is contained in:
parent
aa42ab43f2
commit
ac6c8639bd
41 changed files with 331 additions and 152 deletions
|
|
@ -469,12 +469,14 @@ See also `flyspell-duplicate-distance'."
|
|||
;;;###autoload(defvar flyspell-mode nil)
|
||||
;;;###autoload
|
||||
(define-minor-mode flyspell-mode
|
||||
"Minor mode performing on-the-fly spelling checking.
|
||||
This spawns a single Ispell process and checks each word.
|
||||
The default flyspell behavior is to highlight incorrect words.
|
||||
With no argument, this command toggles Flyspell mode.
|
||||
With a prefix argument ARG, turn Flyspell minor mode on if ARG is positive,
|
||||
otherwise turn it off.
|
||||
"Toggle on-the-fly spell checking (Flyspell mode).
|
||||
With a prefix argument ARG, enable Flyspell mode if ARG is
|
||||
positive, and disable it otherwise. If called from Lisp, enable
|
||||
the mode if ARG is omitted or nil.
|
||||
|
||||
Flyspell mode is a buffer-local minor mode. When enabled, it
|
||||
spawns a single Ispell process and checks each word. The default
|
||||
flyspell behavior is to highlight incorrect words.
|
||||
|
||||
Bindings:
|
||||
\\[ispell-word]: correct words (using Ispell).
|
||||
|
|
|
|||
|
|
@ -3462,15 +3462,21 @@ available on the net."
|
|||
|
||||
;;;###autoload
|
||||
(define-minor-mode ispell-minor-mode
|
||||
"Toggle Ispell minor mode.
|
||||
With prefix argument ARG, turn Ispell minor mode on if ARG is positive,
|
||||
otherwise turn it off.
|
||||
"Toggle last-word spell checking (Ispell minor mode).
|
||||
With a prefix argument ARG, enable Ispell minor mode if ARG is
|
||||
positive, and disable it otherwise. If called from Lisp, enable
|
||||
the mode if ARG is omitted or nil.
|
||||
|
||||
In Ispell minor mode, pressing SPC or RET
|
||||
warns you if the previous word is incorrectly spelled.
|
||||
Ispell minor mode is a buffer-local mior mode. When enabled,
|
||||
typing SPC or RET warns you if the previous word is incorrectly
|
||||
spelled.
|
||||
|
||||
All the buffer-local variables and dictionaries are ignored -- to read
|
||||
them into the running ispell process, type \\[ispell-word] SPC."
|
||||
All the buffer-local variables and dictionaries are ignored. To
|
||||
read them into the running ispell process, type \\[ispell-word]
|
||||
SPC.
|
||||
|
||||
For spell-checking \"on the fly\", not just after typing SPC or
|
||||
RET, use `flyspell-mode'."
|
||||
nil " Spell" ispell-minor-keymap)
|
||||
|
||||
(defun ispell-minor-check ()
|
||||
|
|
|
|||
|
|
@ -297,11 +297,17 @@ automatically inserts the matching closing request after point."
|
|||
(forward-char 1))))
|
||||
|
||||
(define-minor-mode nroff-electric-mode
|
||||
"Toggle `nroff-electric-newline' minor mode.
|
||||
`nroff-electric-newline' forces Emacs to check for an nroff request at the
|
||||
beginning of the line, and insert the matching closing request if necessary.
|
||||
This command toggles that mode (off->on, on->off), with an argument,
|
||||
turns it on if arg is positive, otherwise off."
|
||||
"Toggle automatic nroff request pairing (Nroff Electric mode).
|
||||
With a prefix argument ARG, enable Nroff Electric mode if ARG is
|
||||
positive, and disable it otherwise. If called from Lisp, enable
|
||||
the mode if ARG is omitted or nil.
|
||||
|
||||
Nroff Electric mode is a buffer-local minor mode, for use with
|
||||
`nroff-mode'. When enabled, Emacs checks for an nroff request at
|
||||
the beginning of the line, and inserts the matching closing
|
||||
request if necessary. This command toggles that mode (off->on,
|
||||
on->off), with an argument, turns it on if arg is positive,
|
||||
otherwise off."
|
||||
:lighter " Electric"
|
||||
(or (derived-mode-p 'nroff-mode) (error "Must be in nroff mode")))
|
||||
|
||||
|
|
|
|||
|
|
@ -35,19 +35,23 @@
|
|||
|
||||
(put 'use-hard-newlines 'permanent-local t)
|
||||
(define-minor-mode use-hard-newlines
|
||||
"Minor mode to distinguish hard and soft newlines.
|
||||
When active, the functions `newline' and `open-line' add the
|
||||
"Toggle distinguishing between hard and soft newlines.
|
||||
With a prefix argument ARG, enable the feature if ARG is
|
||||
positive, and disable it otherwise. If called from Lisp, enable
|
||||
it if ARG is omitted or nil.
|
||||
|
||||
When enabled, the functions `newline' and `open-line' add the
|
||||
text-property `hard' to newlines that they insert, and a line is
|
||||
only considered as a candidate to match `paragraph-start' or
|
||||
`paragraph-separate' if it follows a hard newline.
|
||||
|
||||
Prefix argument says to turn mode on if positive, off if negative.
|
||||
When the mode is turned on, if there are newlines in the buffer but no hard
|
||||
newlines, ask the user whether to mark as hard any newlines preceding a
|
||||
`paragraph-start' line. From a program, second arg INSERT specifies whether
|
||||
to do this; it can be `never' to change nothing, t or `always' to force
|
||||
marking, `guess' to try to do the right thing with no questions, nil
|
||||
or anything else to ask the user.
|
||||
When enabling, if there are newlines in the buffer but no hard
|
||||
newlines, ask the user whether to mark as hard any newlines
|
||||
preceding a `paragraph-start' line. From a program, second arg
|
||||
INSERT specifies whether to do this; it can be `never' to change
|
||||
nothing, t or `always' to force marking, `guess' to try to do the
|
||||
right thing with no questions, nil or anything else to ask the
|
||||
user.
|
||||
|
||||
Newlines not marked hard are called \"soft\", and are always internal
|
||||
to paragraphs. The fill functions insert and delete only soft newlines."
|
||||
|
|
|
|||
|
|
@ -213,12 +213,17 @@ complex processing.")
|
|||
|
||||
;;;###autoload
|
||||
(define-minor-mode refill-mode
|
||||
"Toggle Refill minor mode.
|
||||
With prefix arg, turn Refill mode on if arg is positive, otherwise turn it off.
|
||||
"Toggle automatic refilling (Refill mode).
|
||||
With a prefix argument ARG, enable Refill mode if ARG is
|
||||
positive, and disable it otherwise. If called from Lisp, enable
|
||||
the mode if ARG is omitted or nil.
|
||||
|
||||
When Refill mode is on, the current paragraph will be formatted when
|
||||
changes are made within it. Self-inserting characters only cause
|
||||
refilling if they would cause auto-filling."
|
||||
Refill mode is a buffer-local minor mode. When enabled, the
|
||||
current paragraph is refilled as you edit. Self-inserting
|
||||
characters only cause refilling if they would cause
|
||||
auto-filling.
|
||||
|
||||
For true \"word wrap\" behavior, use `visual-line-mode' instead."
|
||||
:group 'refill
|
||||
:lighter " Refill"
|
||||
:keymap '(("\177" . backward-delete-char-untabify))
|
||||
|
|
|
|||
|
|
@ -503,7 +503,13 @@
|
|||
(put 'reftex-mode :menu-tag "RefTeX Mode")
|
||||
;;;###autoload
|
||||
(define-minor-mode reftex-mode
|
||||
"Minor mode with distinct support for \\label, \\ref and \\cite in LaTeX.
|
||||
"Toggle RefTeX mode.
|
||||
With a prefix argument ARG, enable RefTeX mode if ARG is
|
||||
positive, and disable it otherwise. If called from Lisp, enable
|
||||
the mode if ARG is omitted or nil.
|
||||
|
||||
RefTeX mode is a buffer-local minor mode with distinct support
|
||||
for \\label, \\ref and \\cite in LaTeX.
|
||||
|
||||
\\<reftex-mode-map>A Table of Contents of the entire (multifile) document with browsing
|
||||
capabilities is available with `\\[reftex-toc]'.
|
||||
|
|
|
|||
|
|
@ -442,11 +442,10 @@ font-locking of blocks.
|
|||
|
||||
;;;###autoload
|
||||
(define-minor-mode rst-minor-mode
|
||||
"ReST Minor Mode.
|
||||
Toggle ReST minor mode.
|
||||
With no argument, this command toggles the mode.
|
||||
Non-null prefix argument turns on the mode.
|
||||
Null prefix argument turns off the mode.
|
||||
"Toggle ReST minor mode.
|
||||
With a prefix argument ARG, enable ReST minor mode if ARG is
|
||||
positive, and disable it otherwise. If called from Lisp, enable
|
||||
the mode if ARG is omitted or nil.
|
||||
|
||||
When ReST minor mode is enabled, the ReST mode keybindings
|
||||
are installed on top of the major mode bindings. Use this
|
||||
|
|
|
|||
|
|
@ -841,7 +841,14 @@ Return non-nil if we skipped over matched tags."
|
|||
(delete-overlay (pop sgml-electric-tag-pair-overlays))))
|
||||
|
||||
(define-minor-mode sgml-electric-tag-pair-mode
|
||||
"Automatically update the closing tag when editing the opening one."
|
||||
"Toggle SGML Electric Tag Pair mode.
|
||||
With a prefix argument ARG, enable the mode if ARG is positive,
|
||||
and disable it otherwise. If called from Lisp, enable the mode
|
||||
if ARG is omitted or nil.
|
||||
|
||||
SGML Electric Tag Pair mode is a buffer-local minor mode for use
|
||||
with `sgml-mode' and related maor modes. When enabled, editing
|
||||
an opening markup tag automatically updates the closing tag."
|
||||
:lighter "/e"
|
||||
(if sgml-electric-tag-pair-mode
|
||||
(progn
|
||||
|
|
@ -2024,9 +2031,14 @@ The third `match-string' will be the used in the menu.")
|
|||
(nreverse toc-index)))
|
||||
|
||||
(define-minor-mode html-autoview-mode
|
||||
"Toggle automatic viewing via `browse-url-of-buffer' upon saving buffer.
|
||||
With positive prefix ARG always turns viewing on, with negative ARG always off.
|
||||
Can be used as a value for `html-mode-hook'."
|
||||
"Toggle viewing of HTML files on save (HTML Autoview mode).
|
||||
With a prefix argument ARG, enable HTML Autoview mode if ARG is
|
||||
positive, and disable it otherwise. If called from Lisp, enable
|
||||
the mode if ARG is omitted or nil.
|
||||
|
||||
HTML Autoview mode is a buffer-local minor mode for use with
|
||||
`html-mode'. If enabled, saving the file automatically runs
|
||||
`browse-url-of-buffer' to view it."
|
||||
nil nil nil
|
||||
:group 'sgml
|
||||
(if html-autoview-mode
|
||||
|
|
|
|||
|
|
@ -677,8 +677,14 @@ An alternative value is \" . \", if you use a font with a narrow period."
|
|||
(put-text-property start end 'latex-env-pair t)))
|
||||
|
||||
(define-minor-mode latex-electric-env-pair-mode
|
||||
"Automatically update the \\end arg when editing the \\begin one.
|
||||
And vice-versa."
|
||||
"Toggle Latex Electric Env Pair mode.
|
||||
With a prefix argument ARG, enable the mode if ARG is positive,
|
||||
and disable it otherwise. If called from Lisp, enable it if ARG
|
||||
is omitted or nil.
|
||||
|
||||
Latex Electric Env Pair mode is a buffer-local minor mode for use
|
||||
with `latex-mode'. When enabled, typing a \\begin or \\end tag
|
||||
automatically inserts its partner."
|
||||
:lighter "/e"
|
||||
(if latex-electric-env-pair-mode
|
||||
(add-hook 'before-change-functions
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue