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 | |
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')
-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'.") ;;;###autoload (define-minor-mode bug-reference-mode - "Minor mode to buttonize bugzilla references in the current buffer." + "Toggle hyperlinking bug references in the buffer (Bug Reference mode). +With a prefix argument ARG, enable Bug Reference mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." nil "" 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." ;;;###autoload (define-minor-mode capitalized-words-mode "Toggle Capitalized Words mode. +With a prefix argument ARG, enable Capitalized Words mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. -In this minor mode, a word boundary occurs immediately before an -uppercase letter in a symbol. This is in addition to all the normal +Capitalized Words mode is a buffer-local minor mode. When +enabled, a word boundary occurs immediately before an uppercase +letter in a symbol. This is in addition to all the normal boundaries given by the syntax and category tables. There is no restriction to ASCII. 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 ;;;###autoload (define-minor-mode compilation-shell-minor-mode - "Toggle compilation shell minor mode. -With arg, turn compilation mode on if and only if arg is positive. -In this minor mode, all the error-parsing commands of the -Compilation major mode are available but bound to keys that don't -collide with Shell mode. See `compilation-mode'. -Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'." + "Toggle Compilation Shell minor mode. +With a prefix argument ARG, enable Compilation Shell minor mode +if ARG is positive, and disable it otherwise. If called from +Lisp, enable the mode if ARG is omitted or nil. + +When Compilation Shell minor mode is enabled, all the +error-parsing commands of the Compilation major mode are +available but bound to keys that don't collide with Shell mode. +See `compilation-mode'." nil " Shell-Compile" :group 'compilation (if compilation-shell-minor-mode @@ -1982,11 +1985,14 @@ Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'." ;;;###autoload (define-minor-mode compilation-minor-mode - "Toggle compilation minor mode. -With arg, turn compilation mode on if and only if arg is positive. -In this minor mode, all the error-parsing commands of the -Compilation major mode are available. See `compilation-mode'. -Turning the mode on runs the normal hook `compilation-minor-mode-hook'." + "Toggle Compilation minor mode. +With a prefix argument ARG, enable Compilation minor mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. + +When Compilation minor mode is enabled, all the error-parsing +commands of Compilation major mode are available. See +`compilation-mode'." nil " Compilation" :group 'compilation (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." ;;;###autoload (define-minor-mode gud-tooltip-mode - "Toggle the display of GUD tooltips." + "Toggle the display of GUD tooltips. +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." :global t :group 'gud :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 @@ ;;;###autoload (define-minor-mode hide-ifdef-mode - "Toggle Hide-Ifdef mode. This is a minor mode, albeit a large one. -With ARG, turn Hide-Ifdef mode on if arg is positive, off otherwise. -In Hide-Ifdef mode, code within #ifdef constructs that the C preprocessor -would eliminate may be hidden from view. Several variables affect -how the hiding is done: + "Toggle features to hide/show #ifdef blocks (Hide-Ifdef mode). +With a prefix argument ARG, enable Hide-Ifdef mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Hide-Ifdef mode is a buffer-local minor mode for use with C and +C-like major modes. When enabled, code within #ifdef constructs +that the C preprocessor would eliminate may be hidden from view. +Several variables affect how the hiding is done: `hide-ifdef-env' 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." (defvar idlwave-shell-electric-debug-buffers nil) (define-minor-mode idlwave-shell-electric-debug-mode - "Toggle Electric Debug mode. -With no argument, this command toggles the mode. -Non-null prefix argument turns on the mode. -Null prefix argument turns off the mode. - -When Electric Debug mode is enabled, the many debugging commands are -available as single key sequences." -nil -" *Debugging*" -idlwave-shell-electric-debug-mode-map) + "Toggle Idlwave Shell Electric Debug 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. + +When Idlwave Shell Electric Debug mode is enabled, the Idlwave +Shell debugging commands are available as single key sequences." + nil " *Debugging*" idlwave-shell-electric-debug-mode-map) (add-hook '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 @@ ;;;###autoload (define-minor-mode subword-mode - "Mode enabling subword movement and editing keys. -In spite of GNU Coding Standards, it is popular to name a symbol by -mixing uppercase and lowercase letters, e.g. \"GtkWidget\", -\"EmacsFrameClass\", \"NSGraphicsContext\", etc. Here we call these -mixed case symbols `nomenclatures'. Also, each capitalized (or -completely uppercase) part of a nomenclature is called a `subword'. -Here are some examples: + "Toggle subword movement and editing (Subword mode). +With a prefix argument ARG, enable Subword mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Subword mode is a buffer-local minor mode. Enabling it remaps +word-based editing commands to subword-based commands that handle +symbols with mixed uppercase and lowercase letters, +e.g. \"GtkWidget\", \"EmacsFrameClass\", \"NSGraphicsContext\". + +Here we call these mixed case symbols `nomenclatures'. Each +capitalized (or completely uppercase) part of a nomenclature is +called a `subword'. Here are some examples: Nomenclature Subwords =========================================================== 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." (define-minor-mode vhdl-electric-mode "Toggle VHDL electric mode. -Turn on if ARG positive, turn off if ARG negative, toggle if ARG zero or nil." +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." :global t) (define-minor-mode vhdl-stutter-mode "Toggle VHDL stuttering mode. -Turn on if ARG positive, turn off if ARG negative, toggle if ARG zero or nil." +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." :global t) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 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)) |