aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Love1999-09-04 11:29:26 +0000
committerDave Love1999-09-04 11:29:26 +0000
commit688953b5feba04e0fcb434b247722cf6050453c5 (patch)
tree83733e84b2973149b471d8eece68156b72a26135
parentb0f08a24a45bd755ee88224ebff15f84233a31c6 (diff)
downloademacs-688953b5feba04e0fcb434b247722cf6050453c5.tar.gz
emacs-688953b5feba04e0fcb434b247722cf6050453c5.zip
Make some doc strings obey the make-docfile convention.
(debug-ignored-errors): Remove BBDB ones.
-rw-r--r--lisp/bindings.el49
1 files changed, 22 insertions, 27 deletions
diff --git a/lisp/bindings.el b/lisp/bindings.el
index 17e512df64e..aaa5d0d9c43 100644
--- a/lisp/bindings.el
+++ b/lisp/bindings.el
@@ -33,8 +33,7 @@
33;;; Such strings read into Lisp as numbers (during the pure-loading phase). 33;;; Such strings read into Lisp as numbers (during the pure-loading phase).
34;;; 34;;;
35;;; But you must obey certain rules to make sure the string is understood 35;;; But you must obey certain rules to make sure the string is understood
36;;; and goes into etc/DOCnnn properly. Otherwise, the string will not go 36;;; and goes into etc/DOCnnn properly.
37;;; anywhere!
38;;; 37;;;
39;;; The doc string must appear in the standard place in a call to 38;;; The doc string must appear in the standard place in a call to
40;;; defun, autoload, defvar or defconst. No Lisp macros are recognized. 39;;; defun, autoload, defvar or defconst. No Lisp macros are recognized.
@@ -64,8 +63,8 @@ mnemonics of the following coding systems:
64 63
65(make-variable-buffer-local 'mode-line-mule-info) 64(make-variable-buffer-local 'mode-line-mule-info)
66 65
67(defvar mode-line-buffer-identification (purecopy '("%12b")) 66(defvar mode-line-buffer-identification (purecopy '("%12b")) "\
68 "Mode-line control for identifying the buffer being displayed. 67Mode-line control for identifying the buffer being displayed.
69Its default value is (\"%12b\"). 68Its default value is (\"%12b\").
70Major modes that edit things other than ordinary files may change this 69Major modes that edit things other than ordinary files may change this
71\(e.g. Info, Dired,...)") 70\(e.g. Info, Dired,...)")
@@ -74,8 +73,8 @@ Major modes that edit things other than ordinary files may change this
74 73
75(defvar mode-line-frame-identification '("-%F ")) 74(defvar mode-line-frame-identification '("-%F "))
76 75
77(defvar mode-line-process nil 76(defvar mode-line-process nil "\
78 "Mode-line control for displaying info on process status. 77Mode-line control for displaying info on process status.
79Normally nil in most modes, since there is no process to display.") 78Normally nil in most modes, since there is no process to display.")
80 79
81(make-variable-buffer-local 'mode-line-process) 80(make-variable-buffer-local 'mode-line-process)
@@ -134,25 +133,25 @@ is okay. See `mode-line-format'.")
134 ;; not really a minor mode... 133 ;; not really a minor mode...
135 (defining-kbd-macro " Def"))) 134 (defining-kbd-macro " Def")))
136 135
137(defvar mode-line-buffer-identification-keymap nil 136(defvar mode-line-buffer-identification-keymap nil "\
138 "Keymap for what is displayed by `mode-line-buffer-identification'.") 137Keymap for what is displayed by `mode-line-buffer-identification'.")
139 138
140(defvar mode-line-minor-mode-keymap nil 139(defvar mode-line-minor-mode-keymap nil "\
141 "Keymap for what is displayed by `mode-line-mode-name'.") 140Keymap for what is displayed by `mode-line-mode-name'.")
142 141
143(defvar mode-line-mode-menu-keymap nil 142(defvar mode-line-mode-menu-keymap nil "\
144 "Keymap for mode operations menu in the mode line.") 143Keymap for mode operations menu in the mode line.")
145 144
146(defun mode-line-unbury-buffer () 145(defun mode-line-unbury-buffer () "\
147 "Switch to the last buffer in the buffer list that is not hidden." 146Switch to the last buffer in the buffer list that is not hidden."
148 (interactive) 147 (interactive)
149 (let ((list (reverse (buffer-list)))) 148 (let ((list (reverse (buffer-list))))
150 (while (eq (sref (buffer-name (car list)) 0) ? ) 149 (while (eq (sref (buffer-name (car list)) 0) ? )
151 (setq list (cdr list))) 150 (setq list (cdr list)))
152 (switch-to-buffer (car list)))) 151 (switch-to-buffer (car list))))
153 152
154(defun mode-line-other-buffer () 153(defun mode-line-other-buffer () "\
155 "Switch to the most recently selected buffer other than the current one." 154Switch to the most recently selected buffer other than the current one."
156 (interactive) 155 (interactive)
157 (switch-to-buffer (other-buffer))) 156 (switch-to-buffer (other-buffer)))
158 157
@@ -166,8 +165,8 @@ is okay. See `mode-line-format'.")
166 (if binding 165 (if binding
167 (call-interactively binding))))) 166 (call-interactively binding)))))
168 167
169(defun mode-line-mode-name () 168(defun mode-line-mode-name () "\
170 "Return a string to display in the mode line for the current mode name." 169Return a string to display in the mode line for the current mode name."
171 (let (length (result mode-name)) 170 (let (length (result mode-name))
172 (when mode-line-mouse-sensitive-p 171 (when mode-line-mouse-sensitive-p
173 (let ((local-map (get-text-property 0 'local-map result)) 172 (let ((local-map (get-text-property 0 'local-map result))
@@ -185,8 +184,8 @@ is okay. See `mode-line-format'.")
185 'help-echo "mouse-3: minor mode menu" result)))) 184 'help-echo "mouse-3: minor mode menu" result))))
186 result)) 185 result))
187 186
188(defvar mode-line-mouse-sensitive-p nil 187(defvar mode-line-mouse-sensitive-p nil "\
189 "Non-nil means mode line has been made mouse-sensitive.") 188Non-nil means mode line has been made mouse-sensitive.")
190 189
191(defun make-mode-line-mouse-sensitive () 190(defun make-mode-line-mouse-sensitive ()
192 (when (and window-system 191 (when (and window-system
@@ -403,11 +402,7 @@ is okay. See `mode-line-format'.")
403 "^Version control package .*.el not found. Use vc.el instead$" 402 "^Version control package .*.el not found. Use vc.el instead$"
404 403
405 ;; cus-edit 404 ;; cus-edit
406 "^No user options have changed defaults in recent Emacs versions$" 405 "^No user options have changed defaults in recent Emacs versions$"))
407
408 ;; BBDB
409 "^no previous record$"
410 "^no next record$"))
411 406
412 407
413(make-variable-buffer-local 'indent-tabs-mode) 408(make-variable-buffer-local 'indent-tabs-mode)
@@ -417,8 +412,8 @@ is okay. See `mode-line-format'.")
417 412
418(define-key esc-map "\t" 'complete-symbol) 413(define-key esc-map "\t" 'complete-symbol)
419 414
420(defun complete-symbol (arg) 415(defun complete-symbol (arg) "\
421 "Perform tags completion on the text around point. 416Perform tags completion on the text around point.
422Completes to the set of names listed in the current tags table. 417Completes to the set of names listed in the current tags table.
423The string to complete is chosen in the same way as the default 418The string to complete is chosen in the same way as the default
424for \\[find-tag] (which see). 419for \\[find-tag] (which see).