aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/textmodes
diff options
context:
space:
mode:
authorChong Yidong2011-10-19 20:26:14 -0400
committerChong Yidong2011-10-19 20:26:14 -0400
commitac6c8639bdb115cf57c65a383b4564aa98505389 (patch)
tree7271460be2206ea711f46b06e895b6b701976769 /lisp/textmodes
parentaa42ab43f2e3ea06adb21f82abb3d4c502bc9d40 (diff)
downloademacs-ac6c8639bdb115cf57c65a383b4564aa98505389.tar.gz
emacs-ac6c8639bdb115cf57c65a383b4564aa98505389.zip
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/textmodes')
-rw-r--r--lisp/textmodes/flyspell.el14
-rw-r--r--lisp/textmodes/ispell.el20
-rw-r--r--lisp/textmodes/nroff-mode.el16
-rw-r--r--lisp/textmodes/paragraphs.el22
-rw-r--r--lisp/textmodes/refill.el15
-rw-r--r--lisp/textmodes/reftex.el8
-rw-r--r--lisp/textmodes/rst.el9
-rw-r--r--lisp/textmodes/sgml-mode.el20
-rw-r--r--lisp/textmodes/tex-mode.el10
9 files changed, 90 insertions, 44 deletions
diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el
index d496298768d..4a57d00d702 100644
--- a/lisp/textmodes/flyspell.el
+++ b/lisp/textmodes/flyspell.el
@@ -469,12 +469,14 @@ See also `flyspell-duplicate-distance'."
469;;;###autoload(defvar flyspell-mode nil) 469;;;###autoload(defvar flyspell-mode nil)
470;;;###autoload 470;;;###autoload
471(define-minor-mode flyspell-mode 471(define-minor-mode flyspell-mode
472 "Minor mode performing on-the-fly spelling checking. 472 "Toggle on-the-fly spell checking (Flyspell mode).
473This spawns a single Ispell process and checks each word. 473With a prefix argument ARG, enable Flyspell mode if ARG is
474The default flyspell behavior is to highlight incorrect words. 474positive, and disable it otherwise. If called from Lisp, enable
475With no argument, this command toggles Flyspell mode. 475the mode if ARG is omitted or nil.
476With a prefix argument ARG, turn Flyspell minor mode on if ARG is positive, 476
477otherwise turn it off. 477Flyspell mode is a buffer-local minor mode. When enabled, it
478spawns a single Ispell process and checks each word. The default
479flyspell behavior is to highlight incorrect words.
478 480
479Bindings: 481Bindings:
480\\[ispell-word]: correct words (using Ispell). 482\\[ispell-word]: correct words (using Ispell).
diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el
index b76b0a303df..62f899d1730 100644
--- a/lisp/textmodes/ispell.el
+++ b/lisp/textmodes/ispell.el
@@ -3462,15 +3462,21 @@ available on the net."
3462 3462
3463;;;###autoload 3463;;;###autoload
3464(define-minor-mode ispell-minor-mode 3464(define-minor-mode ispell-minor-mode
3465 "Toggle Ispell minor mode. 3465 "Toggle last-word spell checking (Ispell minor mode).
3466With prefix argument ARG, turn Ispell minor mode on if ARG is positive, 3466With a prefix argument ARG, enable Ispell minor mode if ARG is
3467otherwise turn it off. 3467positive, and disable it otherwise. If called from Lisp, enable
3468the mode if ARG is omitted or nil.
3468 3469
3469In Ispell minor mode, pressing SPC or RET 3470Ispell minor mode is a buffer-local mior mode. When enabled,
3470warns you if the previous word is incorrectly spelled. 3471typing SPC or RET warns you if the previous word is incorrectly
3472spelled.
3471 3473
3472All the buffer-local variables and dictionaries are ignored -- to read 3474All the buffer-local variables and dictionaries are ignored. To
3473them into the running ispell process, type \\[ispell-word] SPC." 3475read them into the running ispell process, type \\[ispell-word]
3476SPC.
3477
3478For spell-checking \"on the fly\", not just after typing SPC or
3479RET, use `flyspell-mode'."
3474 nil " Spell" ispell-minor-keymap) 3480 nil " Spell" ispell-minor-keymap)
3475 3481
3476(defun ispell-minor-check () 3482(defun ispell-minor-check ()
diff --git a/lisp/textmodes/nroff-mode.el b/lisp/textmodes/nroff-mode.el
index 8fb0bd85dab..1be78ed293f 100644
--- a/lisp/textmodes/nroff-mode.el
+++ b/lisp/textmodes/nroff-mode.el
@@ -297,11 +297,17 @@ automatically inserts the matching closing request after point."
297 (forward-char 1)))) 297 (forward-char 1))))
298 298
299(define-minor-mode nroff-electric-mode 299(define-minor-mode nroff-electric-mode
300 "Toggle `nroff-electric-newline' minor mode. 300 "Toggle automatic nroff request pairing (Nroff Electric mode).
301`nroff-electric-newline' forces Emacs to check for an nroff request at the 301With a prefix argument ARG, enable Nroff Electric mode if ARG is
302beginning of the line, and insert the matching closing request if necessary. 302positive, and disable it otherwise. If called from Lisp, enable
303This command toggles that mode (off->on, on->off), with an argument, 303the mode if ARG is omitted or nil.
304turns it on if arg is positive, otherwise off." 304
305Nroff Electric mode is a buffer-local minor mode, for use with
306`nroff-mode'. When enabled, Emacs checks for an nroff request at
307the beginning of the line, and inserts the matching closing
308request if necessary. This command toggles that mode (off->on,
309on->off), with an argument, turns it on if arg is positive,
310otherwise off."
305 :lighter " Electric" 311 :lighter " Electric"
306 (or (derived-mode-p 'nroff-mode) (error "Must be in nroff mode"))) 312 (or (derived-mode-p 'nroff-mode) (error "Must be in nroff mode")))
307 313
diff --git a/lisp/textmodes/paragraphs.el b/lisp/textmodes/paragraphs.el
index 8fd055f7d87..b47924bc1f2 100644
--- a/lisp/textmodes/paragraphs.el
+++ b/lisp/textmodes/paragraphs.el
@@ -35,19 +35,23 @@
35 35
36(put 'use-hard-newlines 'permanent-local t) 36(put 'use-hard-newlines 'permanent-local t)
37(define-minor-mode use-hard-newlines 37(define-minor-mode use-hard-newlines
38 "Minor mode to distinguish hard and soft newlines. 38 "Toggle distinguishing between hard and soft newlines.
39When active, the functions `newline' and `open-line' add the 39With a prefix argument ARG, enable the feature if ARG is
40positive, and disable it otherwise. If called from Lisp, enable
41it if ARG is omitted or nil.
42
43When enabled, the functions `newline' and `open-line' add the
40text-property `hard' to newlines that they insert, and a line is 44text-property `hard' to newlines that they insert, and a line is
41only considered as a candidate to match `paragraph-start' or 45only considered as a candidate to match `paragraph-start' or
42`paragraph-separate' if it follows a hard newline. 46`paragraph-separate' if it follows a hard newline.
43 47
44Prefix argument says to turn mode on if positive, off if negative. 48When enabling, if there are newlines in the buffer but no hard
45When the mode is turned on, if there are newlines in the buffer but no hard 49newlines, ask the user whether to mark as hard any newlines
46newlines, ask the user whether to mark as hard any newlines preceding a 50preceding a `paragraph-start' line. From a program, second arg
47`paragraph-start' line. From a program, second arg INSERT specifies whether 51INSERT specifies whether to do this; it can be `never' to change
48to do this; it can be `never' to change nothing, t or `always' to force 52nothing, t or `always' to force marking, `guess' to try to do the
49marking, `guess' to try to do the right thing with no questions, nil 53right thing with no questions, nil or anything else to ask the
50or anything else to ask the user. 54user.
51 55
52Newlines not marked hard are called \"soft\", and are always internal 56Newlines not marked hard are called \"soft\", and are always internal
53to paragraphs. The fill functions insert and delete only soft newlines." 57to paragraphs. The fill functions insert and delete only soft newlines."
diff --git a/lisp/textmodes/refill.el b/lisp/textmodes/refill.el
index 474872955b4..d60b7594c07 100644
--- a/lisp/textmodes/refill.el
+++ b/lisp/textmodes/refill.el
@@ -213,12 +213,17 @@ complex processing.")
213 213
214;;;###autoload 214;;;###autoload
215(define-minor-mode refill-mode 215(define-minor-mode refill-mode
216 "Toggle Refill minor mode. 216 "Toggle automatic refilling (Refill mode).
217With prefix arg, turn Refill mode on if arg is positive, otherwise turn it off. 217With a prefix argument ARG, enable Refill mode if ARG is
218positive, and disable it otherwise. If called from Lisp, enable
219the mode if ARG is omitted or nil.
218 220
219When Refill mode is on, the current paragraph will be formatted when 221Refill mode is a buffer-local minor mode. When enabled, the
220changes are made within it. Self-inserting characters only cause 222current paragraph is refilled as you edit. Self-inserting
221refilling if they would cause auto-filling." 223characters only cause refilling if they would cause
224auto-filling.
225
226For true \"word wrap\" behavior, use `visual-line-mode' instead."
222 :group 'refill 227 :group 'refill
223 :lighter " Refill" 228 :lighter " Refill"
224 :keymap '(("\177" . backward-delete-char-untabify)) 229 :keymap '(("\177" . backward-delete-char-untabify))
diff --git a/lisp/textmodes/reftex.el b/lisp/textmodes/reftex.el
index 7e150bff997..6f6993980db 100644
--- a/lisp/textmodes/reftex.el
+++ b/lisp/textmodes/reftex.el
@@ -503,7 +503,13 @@
503(put 'reftex-mode :menu-tag "RefTeX Mode") 503(put 'reftex-mode :menu-tag "RefTeX Mode")
504;;;###autoload 504;;;###autoload
505(define-minor-mode reftex-mode 505(define-minor-mode reftex-mode
506 "Minor mode with distinct support for \\label, \\ref and \\cite in LaTeX. 506 "Toggle RefTeX mode.
507With a prefix argument ARG, enable RefTeX mode if ARG is
508positive, and disable it otherwise. If called from Lisp, enable
509the mode if ARG is omitted or nil.
510
511RefTeX mode is a buffer-local minor mode with distinct support
512for \\label, \\ref and \\cite in LaTeX.
507 513
508\\<reftex-mode-map>A Table of Contents of the entire (multifile) document with browsing 514\\<reftex-mode-map>A Table of Contents of the entire (multifile) document with browsing
509capabilities is available with `\\[reftex-toc]'. 515capabilities is available with `\\[reftex-toc]'.
diff --git a/lisp/textmodes/rst.el b/lisp/textmodes/rst.el
index c1ce950522c..f9fda7e0a74 100644
--- a/lisp/textmodes/rst.el
+++ b/lisp/textmodes/rst.el
@@ -442,11 +442,10 @@ font-locking of blocks.
442 442
443;;;###autoload 443;;;###autoload
444(define-minor-mode rst-minor-mode 444(define-minor-mode rst-minor-mode
445 "ReST Minor Mode. 445 "Toggle ReST minor mode.
446Toggle ReST minor mode. 446With a prefix argument ARG, enable ReST minor mode if ARG is
447With no argument, this command toggles the mode. 447positive, and disable it otherwise. If called from Lisp, enable
448Non-null prefix argument turns on the mode. 448the mode if ARG is omitted or nil.
449Null prefix argument turns off the mode.
450 449
451When ReST minor mode is enabled, the ReST mode keybindings 450When ReST minor mode is enabled, the ReST mode keybindings
452are installed on top of the major mode bindings. Use this 451are installed on top of the major mode bindings. Use this
diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el
index 314fbf9671b..be8dd9c9130 100644
--- a/lisp/textmodes/sgml-mode.el
+++ b/lisp/textmodes/sgml-mode.el
@@ -841,7 +841,14 @@ Return non-nil if we skipped over matched tags."
841 (delete-overlay (pop sgml-electric-tag-pair-overlays)))) 841 (delete-overlay (pop sgml-electric-tag-pair-overlays))))
842 842
843(define-minor-mode sgml-electric-tag-pair-mode 843(define-minor-mode sgml-electric-tag-pair-mode
844 "Automatically update the closing tag when editing the opening one." 844 "Toggle SGML Electric Tag Pair mode.
845With a prefix argument ARG, enable the mode if ARG is positive,
846and disable it otherwise. If called from Lisp, enable the mode
847if ARG is omitted or nil.
848
849SGML Electric Tag Pair mode is a buffer-local minor mode for use
850with `sgml-mode' and related maor modes. When enabled, editing
851an opening markup tag automatically updates the closing tag."
845 :lighter "/e" 852 :lighter "/e"
846 (if sgml-electric-tag-pair-mode 853 (if sgml-electric-tag-pair-mode
847 (progn 854 (progn
@@ -2024,9 +2031,14 @@ The third `match-string' will be the used in the menu.")
2024 (nreverse toc-index))) 2031 (nreverse toc-index)))
2025 2032
2026(define-minor-mode html-autoview-mode 2033(define-minor-mode html-autoview-mode
2027 "Toggle automatic viewing via `browse-url-of-buffer' upon saving buffer. 2034 "Toggle viewing of HTML files on save (HTML Autoview mode).
2028With positive prefix ARG always turns viewing on, with negative ARG always off. 2035With a prefix argument ARG, enable HTML Autoview mode if ARG is
2029Can be used as a value for `html-mode-hook'." 2036positive, and disable it otherwise. If called from Lisp, enable
2037the mode if ARG is omitted or nil.
2038
2039HTML Autoview mode is a buffer-local minor mode for use with
2040`html-mode'. If enabled, saving the file automatically runs
2041`browse-url-of-buffer' to view it."
2030 nil nil nil 2042 nil nil nil
2031 :group 'sgml 2043 :group 'sgml
2032 (if html-autoview-mode 2044 (if html-autoview-mode
diff --git a/lisp/textmodes/tex-mode.el b/lisp/textmodes/tex-mode.el
index 428fc1db3a9..deb92fc0243 100644
--- a/lisp/textmodes/tex-mode.el
+++ b/lisp/textmodes/tex-mode.el
@@ -677,8 +677,14 @@ An alternative value is \" . \", if you use a font with a narrow period."
677 (put-text-property start end 'latex-env-pair t))) 677 (put-text-property start end 'latex-env-pair t)))
678 678
679(define-minor-mode latex-electric-env-pair-mode 679(define-minor-mode latex-electric-env-pair-mode
680 "Automatically update the \\end arg when editing the \\begin one. 680 "Toggle Latex Electric Env Pair mode.
681And vice-versa." 681With a prefix argument ARG, enable the mode if ARG is positive,
682and disable it otherwise. If called from Lisp, enable it if ARG
683is omitted or nil.
684
685Latex Electric Env Pair mode is a buffer-local minor mode for use
686with `latex-mode'. When enabled, typing a \\begin or \\end tag
687automatically inserts its partner."
682 :lighter "/e" 688 :lighter "/e"
683 (if latex-electric-env-pair-mode 689 (if latex-electric-env-pair-mode
684 (add-hook 'before-change-functions 690 (add-hook 'before-change-functions