diff options
| author | Chong Yidong | 2011-10-19 20:26:14 -0400 |
|---|---|---|
| committer | Chong Yidong | 2011-10-19 20:26:14 -0400 |
| commit | ac6c8639bdb115cf57c65a383b4564aa98505389 (patch) | |
| tree | 7271460be2206ea711f46b06e895b6b701976769 /lisp/progmodes | |
| parent | aa42ab43f2e3ea06adb21f82abb3d4c502bc9d40 (diff) | |
| download | emacs-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/progmodes')
| -rw-r--r-- | lisp/progmodes/bug-reference.el | 5 | ||||
| -rw-r--r-- | lisp/progmodes/cap-words.el | 8 | ||||
| -rw-r--r-- | lisp/progmodes/compile.el | 28 | ||||
| -rw-r--r-- | lisp/progmodes/gud.el | 5 | ||||
| -rw-r--r-- | lisp/progmodes/hideif.el | 14 | ||||
| -rw-r--r-- | lisp/progmodes/idlw-shell.el | 18 | ||||
| -rw-r--r-- | lisp/progmodes/subword.el | 20 | ||||
| -rw-r--r-- | lisp/progmodes/vhdl-mode.el | 8 | ||||
| -rw-r--r-- | lisp/progmodes/which-func.el | 14 |
9 files changed, 75 insertions, 45 deletions
diff --git a/lisp/progmodes/bug-reference.el b/lisp/progmodes/bug-reference.el index 8ec379afab2..12eddfef1aa 100644 --- a/lisp/progmodes/bug-reference.el +++ b/lisp/progmodes/bug-reference.el | |||
| @@ -127,7 +127,10 @@ so that it is considered safe, see `enable-local-variables'.") | |||
| 127 | 127 | ||
| 128 | ;;;###autoload | 128 | ;;;###autoload |
| 129 | (define-minor-mode bug-reference-mode | 129 | (define-minor-mode bug-reference-mode |
| 130 | "Minor mode to buttonize bugzilla references in the current buffer." | 130 | "Toggle hyperlinking bug references in the buffer (Bug Reference mode). |
| 131 | With a prefix argument ARG, enable Bug Reference mode if ARG is | ||
| 132 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 133 | the mode if ARG is omitted or nil." | ||
| 131 | nil | 134 | nil |
| 132 | "" | 135 | "" |
| 133 | nil | 136 | nil |
diff --git a/lisp/progmodes/cap-words.el b/lisp/progmodes/cap-words.el index 0ce84ae33a7..d7b7dfef1ec 100644 --- a/lisp/progmodes/cap-words.el +++ b/lisp/progmodes/cap-words.el | |||
| @@ -60,9 +60,13 @@ Looks for word boundaries before capitals." | |||
| 60 | ;;;###autoload | 60 | ;;;###autoload |
| 61 | (define-minor-mode capitalized-words-mode | 61 | (define-minor-mode capitalized-words-mode |
| 62 | "Toggle Capitalized Words mode. | 62 | "Toggle Capitalized Words mode. |
| 63 | With a prefix argument ARG, enable Capitalized Words mode if ARG | ||
| 64 | is positive, and disable it otherwise. If called from Lisp, | ||
| 65 | enable the mode if ARG is omitted or nil. | ||
| 63 | 66 | ||
| 64 | In this minor mode, a word boundary occurs immediately before an | 67 | Capitalized Words mode is a buffer-local minor mode. When |
| 65 | uppercase letter in a symbol. This is in addition to all the normal | 68 | enabled, a word boundary occurs immediately before an uppercase |
| 69 | letter in a symbol. This is in addition to all the normal | ||
| 66 | boundaries given by the syntax and category tables. There is no | 70 | boundaries given by the syntax and category tables. There is no |
| 67 | restriction to ASCII. | 71 | restriction to ASCII. |
| 68 | 72 | ||
diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index 619c423902c..156c90159cd 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el | |||
| @@ -1968,12 +1968,15 @@ Optional argument MINOR indicates this is called from | |||
| 1968 | 1968 | ||
| 1969 | ;;;###autoload | 1969 | ;;;###autoload |
| 1970 | (define-minor-mode compilation-shell-minor-mode | 1970 | (define-minor-mode compilation-shell-minor-mode |
| 1971 | "Toggle compilation shell minor mode. | 1971 | "Toggle Compilation Shell minor mode. |
| 1972 | With arg, turn compilation mode on if and only if arg is positive. | 1972 | With a prefix argument ARG, enable Compilation Shell minor mode |
| 1973 | In this minor mode, all the error-parsing commands of the | 1973 | if ARG is positive, and disable it otherwise. If called from |
| 1974 | Compilation major mode are available but bound to keys that don't | 1974 | Lisp, enable the mode if ARG is omitted or nil. |
| 1975 | collide with Shell mode. See `compilation-mode'. | 1975 | |
| 1976 | Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'." | 1976 | When Compilation Shell minor mode is enabled, all the |
| 1977 | error-parsing commands of the Compilation major mode are | ||
| 1978 | available but bound to keys that don't collide with Shell mode. | ||
| 1979 | See `compilation-mode'." | ||
| 1977 | nil " Shell-Compile" | 1980 | nil " Shell-Compile" |
| 1978 | :group 'compilation | 1981 | :group 'compilation |
| 1979 | (if compilation-shell-minor-mode | 1982 | (if compilation-shell-minor-mode |
| @@ -1982,11 +1985,14 @@ Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'." | |||
| 1982 | 1985 | ||
| 1983 | ;;;###autoload | 1986 | ;;;###autoload |
| 1984 | (define-minor-mode compilation-minor-mode | 1987 | (define-minor-mode compilation-minor-mode |
| 1985 | "Toggle compilation minor mode. | 1988 | "Toggle Compilation minor mode. |
| 1986 | With arg, turn compilation mode on if and only if arg is positive. | 1989 | With a prefix argument ARG, enable Compilation minor mode if ARG |
| 1987 | In this minor mode, all the error-parsing commands of the | 1990 | is positive, and disable it otherwise. If called from Lisp, |
| 1988 | Compilation major mode are available. See `compilation-mode'. | 1991 | enable the mode if ARG is omitted or nil. |
| 1989 | Turning the mode on runs the normal hook `compilation-minor-mode-hook'." | 1992 | |
| 1993 | When Compilation minor mode is enabled, all the error-parsing | ||
| 1994 | commands of Compilation major mode are available. See | ||
| 1995 | `compilation-mode'." | ||
| 1990 | nil " Compilation" | 1996 | nil " Compilation" |
| 1991 | :group 'compilation | 1997 | :group 'compilation |
| 1992 | (if compilation-minor-mode | 1998 | (if compilation-minor-mode |
diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 25a23fed293..7b3a2893610 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el | |||
| @@ -3255,7 +3255,10 @@ Treats actions as defuns." | |||
| 3255 | 3255 | ||
| 3256 | ;;;###autoload | 3256 | ;;;###autoload |
| 3257 | (define-minor-mode gud-tooltip-mode | 3257 | (define-minor-mode gud-tooltip-mode |
| 3258 | "Toggle the display of GUD tooltips." | 3258 | "Toggle the display of GUD tooltips. |
| 3259 | With a prefix argument ARG, enable the feature if ARG is | ||
| 3260 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 3261 | it if ARG is omitted or nil." | ||
| 3259 | :global t | 3262 | :global t |
| 3260 | :group 'gud | 3263 | :group 'gud |
| 3261 | :group 'tooltip | 3264 | :group 'tooltip |
diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el index 48d1ac4b85e..374a45acec6 100644 --- a/lisp/progmodes/hideif.el +++ b/lisp/progmodes/hideif.el | |||
| @@ -214,11 +214,15 @@ | |||
| 214 | 214 | ||
| 215 | ;;;###autoload | 215 | ;;;###autoload |
| 216 | (define-minor-mode hide-ifdef-mode | 216 | (define-minor-mode hide-ifdef-mode |
| 217 | "Toggle Hide-Ifdef mode. This is a minor mode, albeit a large one. | 217 | "Toggle features to hide/show #ifdef blocks (Hide-Ifdef mode). |
| 218 | With ARG, turn Hide-Ifdef mode on if arg is positive, off otherwise. | 218 | With a prefix argument ARG, enable Hide-Ifdef mode if ARG is |
| 219 | In Hide-Ifdef mode, code within #ifdef constructs that the C preprocessor | 219 | positive, and disable it otherwise. If called from Lisp, enable |
| 220 | would eliminate may be hidden from view. Several variables affect | 220 | the mode if ARG is omitted or nil. |
| 221 | how the hiding is done: | 221 | |
| 222 | Hide-Ifdef mode is a buffer-local minor mode for use with C and | ||
| 223 | C-like major modes. When enabled, code within #ifdef constructs | ||
| 224 | that the C preprocessor would eliminate may be hidden from view. | ||
| 225 | Several variables affect how the hiding is done: | ||
| 222 | 226 | ||
| 223 | `hide-ifdef-env' | 227 | `hide-ifdef-env' |
| 224 | An association list of defined and undefined symbols for the | 228 | An association list of defined and undefined symbols for the |
diff --git a/lisp/progmodes/idlw-shell.el b/lisp/progmodes/idlw-shell.el index b2cd24f0f98..18f47d14a3f 100644 --- a/lisp/progmodes/idlw-shell.el +++ b/lisp/progmodes/idlw-shell.el | |||
| @@ -4277,16 +4277,14 @@ Otherwise, just expand the file name." | |||
| 4277 | (defvar idlwave-shell-electric-debug-buffers nil) | 4277 | (defvar idlwave-shell-electric-debug-buffers nil) |
| 4278 | 4278 | ||
| 4279 | (define-minor-mode idlwave-shell-electric-debug-mode | 4279 | (define-minor-mode idlwave-shell-electric-debug-mode |
| 4280 | "Toggle Electric Debug mode. | 4280 | "Toggle Idlwave Shell Electric Debug mode. |
| 4281 | With no argument, this command toggles the mode. | 4281 | With a prefix argument ARG, enable the mode if ARG is positive, |
| 4282 | Non-null prefix argument turns on the mode. | 4282 | and disable it otherwise. If called from Lisp, enable the mode |
| 4283 | Null prefix argument turns off the mode. | 4283 | if ARG is omitted or nil. |
| 4284 | 4284 | ||
| 4285 | When Electric Debug mode is enabled, the many debugging commands are | 4285 | When Idlwave Shell Electric Debug mode is enabled, the Idlwave |
| 4286 | available as single key sequences." | 4286 | Shell debugging commands are available as single key sequences." |
| 4287 | nil | 4287 | nil " *Debugging*" idlwave-shell-electric-debug-mode-map) |
| 4288 | " *Debugging*" | ||
| 4289 | idlwave-shell-electric-debug-mode-map) | ||
| 4290 | 4288 | ||
| 4291 | (add-hook | 4289 | (add-hook |
| 4292 | 'idlwave-shell-electric-debug-mode-on-hook | 4290 | 'idlwave-shell-electric-debug-mode-on-hook |
diff --git a/lisp/progmodes/subword.el b/lisp/progmodes/subword.el index 1a403f50b1b..9c61da89008 100644 --- a/lisp/progmodes/subword.el +++ b/lisp/progmodes/subword.el | |||
| @@ -94,13 +94,19 @@ | |||
| 94 | 94 | ||
| 95 | ;;;###autoload | 95 | ;;;###autoload |
| 96 | (define-minor-mode subword-mode | 96 | (define-minor-mode subword-mode |
| 97 | "Mode enabling subword movement and editing keys. | 97 | "Toggle subword movement and editing (Subword mode). |
| 98 | In spite of GNU Coding Standards, it is popular to name a symbol by | 98 | With a prefix argument ARG, enable Subword mode if ARG is |
| 99 | mixing uppercase and lowercase letters, e.g. \"GtkWidget\", | 99 | positive, and disable it otherwise. If called from Lisp, enable |
| 100 | \"EmacsFrameClass\", \"NSGraphicsContext\", etc. Here we call these | 100 | the mode if ARG is omitted or nil. |
| 101 | mixed case symbols `nomenclatures'. Also, each capitalized (or | 101 | |
| 102 | completely uppercase) part of a nomenclature is called a `subword'. | 102 | Subword mode is a buffer-local minor mode. Enabling it remaps |
| 103 | Here are some examples: | 103 | word-based editing commands to subword-based commands that handle |
| 104 | symbols with mixed uppercase and lowercase letters, | ||
| 105 | e.g. \"GtkWidget\", \"EmacsFrameClass\", \"NSGraphicsContext\". | ||
| 106 | |||
| 107 | Here we call these mixed case symbols `nomenclatures'. Each | ||
| 108 | capitalized (or completely uppercase) part of a nomenclature is | ||
| 109 | called a `subword'. Here are some examples: | ||
| 104 | 110 | ||
| 105 | Nomenclature Subwords | 111 | Nomenclature Subwords |
| 106 | =========================================================== | 112 | =========================================================== |
diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index 9aaf3059b78..d7aa82aee1b 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el | |||
| @@ -8029,12 +8029,16 @@ project is defined." | |||
| 8029 | 8029 | ||
| 8030 | (define-minor-mode vhdl-electric-mode | 8030 | (define-minor-mode vhdl-electric-mode |
| 8031 | "Toggle VHDL electric mode. | 8031 | "Toggle VHDL electric mode. |
| 8032 | Turn on if ARG positive, turn off if ARG negative, toggle if ARG zero or nil." | 8032 | With a prefix argument ARG, enable the mode if ARG is positive, |
| 8033 | and disable it otherwise. If called from Lisp, enable it if ARG | ||
| 8034 | is omitted or nil." | ||
| 8033 | :global t) | 8035 | :global t) |
| 8034 | 8036 | ||
| 8035 | (define-minor-mode vhdl-stutter-mode | 8037 | (define-minor-mode vhdl-stutter-mode |
| 8036 | "Toggle VHDL stuttering mode. | 8038 | "Toggle VHDL stuttering mode. |
| 8037 | Turn on if ARG positive, turn off if ARG negative, toggle if ARG zero or nil." | 8039 | With a prefix argument ARG, enable the mode if ARG is positive, |
| 8040 | and disable it otherwise. If called from Lisp, enable it if ARG | ||
| 8041 | is omitted or nil." | ||
| 8038 | :global t) | 8042 | :global t) |
| 8039 | 8043 | ||
| 8040 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | 8044 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
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." | |||
| 236 | ;; This is the name people would normally expect. | 236 | ;; This is the name people would normally expect. |
| 237 | ;;;###autoload | 237 | ;;;###autoload |
| 238 | (define-minor-mode which-function-mode | 238 | (define-minor-mode which-function-mode |
| 239 | "Toggle Which Function mode, globally. | 239 | "Toggle mode line display of current function (Which Function mode). |
| 240 | When Which Function mode is enabled, the current function name is | 240 | With a prefix argument ARG, enable Which Function mode if ARG is |
| 241 | continuously displayed in the mode line, in certain major modes. | 241 | positive, and disable it otherwise. If called from Lisp, enable |
| 242 | 242 | the mode if ARG is omitted or nil. | |
| 243 | With prefix ARG, turn Which Function mode on if arg is positive, | 243 | |
| 244 | and off otherwise." | 244 | Which Function mode is a global minor mode. When enabled, the |
| 245 | current function name is continuously displayed in the mode line, | ||
| 246 | in certain major modes." | ||
| 245 | :global t :group 'which-func | 247 | :global t :group 'which-func |
| 246 | (when (timerp which-func-update-timer) | 248 | (when (timerp which-func-update-timer) |
| 247 | (cancel-timer which-func-update-timer)) | 249 | (cancel-timer which-func-update-timer)) |