Commit ac6c8639 authored by Chong Yidong's avatar Chong Yidong
Browse files

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).
parent aa42ab43
2011-10-20 Chong Yidong <cyd@gnu.org>
* emulation/cua-base.el (cua-mode):
* mail/footnote.el (footnote-mode):
* mail/mailabbrev.el (mail-abbrevs-mode):
* net/xesam.el (xesam-minor-mode):
* progmodes/bug-reference.el (bug-reference-mode):
* progmodes/cap-words.el (capitalized-words-mode):
* progmodes/compile.el (compilation-minor-mode)
(compilation-shell-minor-mode):
* progmodes/gud.el (gud-tooltip-mode):
* progmodes/hideif.el (hide-ifdef-mode):
* progmodes/idlw-shell.el (idlwave-shell-electric-debug-mode):
* progmodes/subword.el (subword-mode):
* progmodes/vhdl-mode.el (vhdl-electric-mode, vhdl-stutter-mode):
* progmodes/which-func.el (which-function-mode):
* term/tvi970.el (tvi970-set-keypad-mode):
* term/vt100.el (vt100-wide-mode):
* textmodes/flyspell.el (flyspell-mode):
* textmodes/ispell.el (ispell-minor-mode):
* textmodes/nroff-mode.el (nroff-electric-mode):
* textmodes/paragraphs.el (use-hard-newlines):
* textmodes/refill.el (refill-mode):
* textmodes/reftex.el (reftex-mode):
* textmodes/rst.el (rst-minor-mode):
* textmodes/sgml-mode.el (html-autoview-mode)
(sgml-electric-tag-pair-mode):
* textmodes/tex-mode.el (latex-electric-env-pair-mode):
* vc/diff-mode.el (diff-auto-refine-mode, diff-minor-mode):
* emulation/crisp.el (crisp-mode):
* emacs-lisp/eldoc.el (eldoc-mode):
* emacs-lisp/checkdoc.el (checkdoc-minor-mode): Doc fixes for new
minor mode behavior.
2011-10-19 Juri Linkov <juri@jurta.org>
* descr-text.el (describe-char): Add #x2010 and #x2011 to
......
2011-10-19 Chong Yidong <cyd@gnu.org>
* ede.el (ede-minor-mode,global-ede-mode):
* semantic.el (semantic-mode): Doc fix to reflect new
define-minor-mode calling behavior.
2011-07-30 Chong Yidong <cyd@stupidchicken.com>
* semantic/grammar.el (semantic-grammar-insert-defanalyzers): Fix
......
......@@ -398,8 +398,9 @@ To be used in hook functions."
(define-minor-mode ede-minor-mode
"Toggle EDE (Emacs Development Environment) minor mode.
With non-nil argument ARG, enable EDE minor mode if ARG is
positive; otherwise, disable it.
With a prefix argument ARG, enable EDE minor mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
EDE minor mode if ARG is omitted or nil.
If this file is contained, or could be contained in an EDE
controlled project, then this mode is activated automatically
......@@ -458,8 +459,9 @@ ONOFF indicates enabling or disabling the mode."
;;;###autoload
(define-minor-mode global-ede-mode
"Toggle global EDE (Emacs Development Environment) mode.
With non-nil argument ARG, enable global EDE mode if ARG is
positive; otherwise, disable it.
With a prefix argument ARG, enable global EDE mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
This global minor mode enables `ede-minor-mode' in all buffers in
an EDE controlled project."
......
......@@ -1055,8 +1055,10 @@ The possible elements of this list include the following:
;;;###autoload
(define-minor-mode semantic-mode
"Toggle Semantic mode.
With ARG, turn Semantic mode on if ARG is positive, off otherwise.
"Toggle parser features (Semantic mode).
With a prefix argument ARG, enable Semantic mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
Semantic mode if ARG is omitted or nil.
In Semantic mode, Emacs parses the buffers you visit for their
semantic content. This information is used by a variety of
......
......@@ -1237,9 +1237,10 @@ generating a buffered list of errors."
;;;###autoload
(define-minor-mode checkdoc-minor-mode
"Toggle Checkdoc minor mode, a mode for checking Lisp doc strings.
With prefix ARG, turn Checkdoc minor mode on if ARG is positive, otherwise
turn it off.
"Toggle automatic docstring checking (Checkdoc minor mode).
With a prefix argument ARG, enable Checkdoc minor mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
In Checkdoc minor mode, the usual bindings for `eval-defun' which is
bound to \\<checkdoc-minor-mode-map>\\[checkdoc-eval-defun] and `checkdoc-eval-current-buffer' are overridden to include
......
......@@ -149,14 +149,17 @@ This is used to determine if `eldoc-idle-delay' is changed by the user.")
;;;###autoload
(define-minor-mode eldoc-mode
"Toggle ElDoc mode on or off.
In ElDoc mode, the echo area displays information about a
function or variable in the text where point is. If point is
on a documented variable, it displays the first line of that
variable's doc string. Otherwise it displays the argument list
of the function called in the expression point is on.
With prefix ARG, turn ElDoc mode on if and only if ARG is positive."
"Toggle echo area display of Lisp objects at point (ElDoc mode).
With a prefix argument ARG, enable ElDoc mode if ARG is positive,
and disable it otherwise. If called from Lisp, enable ElDoc mode
if ARG is omitted or nil.
ElDoc mode is a buffer-local minor mode. When enabled, the echo
area displays information about a function or variable in the
text where point is. If point is on a documented variable, it
displays the first line of that variable's doc string. Otherwise
it displays the argument list of the function called in the
expression point is on."
:group 'eldoc :lighter eldoc-minor-mode-string
(setq eldoc-last-message nil)
(if eldoc-mode
......
......@@ -349,8 +349,10 @@ normal CRiSP binding) and when it is nil M-x will run
;;;###autoload
(define-minor-mode crisp-mode
"Toggle CRiSP/Brief emulation minor mode.
With ARG, turn CRiSP mode on if ARG is positive, off otherwise."
"Toggle CRiSP/Brief emulation (CRiSP mode).
With a prefix argument ARG, enable CRiSP mode if ARG is positive,
and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil."
:keymap crisp-mode-map
:lighter crisp-mode-modeline-string
(when crisp-mode
......
......@@ -1531,16 +1531,17 @@ If ARG is the atom `-', scroll upward by nearly full screen."
;;;###autoload
(define-minor-mode cua-mode
"Toggle CUA key-binding mode.
When enabled, using shifted movement keys will activate the
region (and highlight the region using `transient-mark-mode'),
and typed text replaces the active selection.
Also when enabled, you can use C-z, C-x, C-c, and C-v to undo,
cut, copy, and paste in addition to the normal Emacs bindings.
The C-x and C-c keys only do cut and copy when the region is
active, so in most cases, they do not conflict with the normal
function of these prefix keys.
"Toggle Common User Access style editing (CUA mode).
With a prefix argument ARG, enable CUA mode if ARG is positive,
and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil.
CUA mode is a global minor mode. When enabled, typed text
replaces the active selection, and you can use C-z, C-x, C-c, and
C-v to undo, cut, copy, and paste in addition to the normal Emacs
bindings. The C-x and C-c keys only do cut and copy when the
region is active, so in most cases, they do not conflict with the
normal function of these prefix keys.
If you really need to perform a command which starts with one of
the prefix keys even when the region is active, you have three
......
2011-10-20 Chong Yidong <cyd@gnu.org>
* erc.el (define-erc-module): Fix autogenerated docstring to
reflect Emacs 24 minor mode changes.
* erc-fill.el (erc-fill-mode):
* erc-track.el (erc-track-minor-mode): Doc fix.
2011-09-23 Antoine Levitt <antoine.levitt@gmail.com>
* erc-button.el (erc-button-next-function): Scoping fix
......
......@@ -39,9 +39,12 @@
;;;###autoload (autoload 'erc-fill-mode "erc-fill" nil t)
(erc-define-minor-mode erc-fill-mode
"Toggle ERC fill mode.
With numeric arg, turn ERC fill mode on if and only if arg is
positive. In ERC fill mode, messages in the channel buffers are
filled."
With a prefix argument ARG, enable ERC fill mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
ERC fill mode is a global minor mode. When enabled, messages in
the channel buffers are filled."
nil nil nil
:global t :group 'erc-fill
(if erc-fill-mode
......
......@@ -588,12 +588,15 @@ START is the minimum length of the name used."
;;;###autoload
(define-minor-mode erc-track-minor-mode
"Global minor mode for tracking ERC buffers and showing activity in the
mode line.
This exists for the sole purpose of providing the C-c C-SPC and
C-c C-@ keybindings. Make sure that you have enabled the track
module, otherwise the keybindings will not do anything useful."
"Toggle mode line display of ERC activity (ERC Track minor mode).
With a prefix argument ARG, enable ERC Track minor mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
ERC Track minor mode is a global minor mode. It exists for the
sole purpose of providing the C-c C-SPC and C-c C-@ keybindings.
Make sure that you have enabled the track module, otherwise the
keybindings will not do anything useful."
:init-value nil
:lighter ""
:keymap erc-track-minor-mode-map
......
......@@ -1242,7 +1242,9 @@ Example:
(erc-define-minor-mode
,mode
,(format "Toggle ERC %S mode.
With arg, turn ERC %S mode on if and only if arg is positive.
With a prefix argument ARG, enable %s if ARG is positive,
and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil.
%s" name name doc)
nil nil nil
:global ,(not local-p) :group (quote ,group)
......
2011-10-20 Chong Yidong <cyd@gnu.org>
* 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).
2011-10-18 Teodor Zlatanov <tzz@lifelogs.com>
 
* gnus-util.el (gnus-bound-and-true-p): Macro for XEmacs compatibility.
......
......@@ -1224,13 +1224,8 @@ Returns nil if there is no such line before LIMIT, t otherwise."
(autoload 'font-lock-set-defaults "font-lock")))
(define-minor-mode gnus-message-citation-mode
"Toggle `gnus-message-citation-mode' in current buffer.
This buffer local minor mode provides additional font-lock support for
nested citations.
With prefix ARG, turn `gnus-message-citation-mode' on if and only if ARG
is positive.
Automatically turn `font-lock-mode' on when `gnus-message-citation-mode'
is turned on."
"Minor mode providing more font-lock support for nested citations.
When enabled, it automatically turns on `font-lock-mode'."
nil ;; init-value
"" ;; lighter
nil ;; keymap
......
......@@ -788,9 +788,14 @@ being set it is automatically widened."
;;;###autoload
(define-minor-mode footnote-mode
"Toggle footnote minor mode.
This minor mode provides footnote support for `message-mode'. To get
started, play around with the following keys:
"Toggle Footnote mode.
With a prefix argument ARG, enable Footnote mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
Footnode mode is a buffer-local minor mode. If enabled, it
provides footnote support for `message-mode'. To get started,
play around with the following keys:
\\{footnote-minor-mode-map}"
:lighter footnote-mode-line-string
:keymap footnote-minor-mode-map
......
......@@ -133,7 +133,15 @@
;;;###autoload
(define-minor-mode mail-abbrevs-mode
"Non-nil means expand mail aliases as abbrevs, in certain message headers."
"Toggle abbrev expansion of mail aliases (Mail Abbrevs mode).
With a prefix argument ARG, enable Mail Abbrevs mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
Mail Abbrevs mode is a global minor mode. When enabled,
abbrev-like expansion is performed when editing certain mail
headers (those specified by `mail-abbrev-mode-regexp'), based on
the entries in your `mail-personal-alias-file'."
:global t
:group 'mail-abbrev
:version "20.3"
......
......@@ -288,7 +288,7 @@ Also fontifies the buffer appropriately (see `goto-address-fontify-p' and
;;;###autoload
(define-minor-mode goto-address-prog-mode
"Turn on `goto-address-mode', but only in comments and strings."
"Like `goto-address-mode', but only for comments and strings."
nil
""
nil
......
......@@ -516,9 +516,9 @@ engine specific, widget :notify function to visualize xesam:url."
(define-minor-mode xesam-minor-mode
"Toggle Xesam 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.
With a prefix argument ARG, enable Xesam minor mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
When Xesam minor mode is enabled, all text which matches a
previous Xesam query in this buffer is highlighted."
......
......@@ -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
......
......@@ -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.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment