diff options
| author | Juanma Barranquero | 2007-10-31 09:02:14 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2007-10-31 09:02:14 +0000 |
| commit | 20ba690ce00c42cc2be78778ba32caba76491b8c (patch) | |
| tree | 3ccdbbf61733aa8dac2e76b706e3ca01d48390d6 | |
| parent | 1cf46be3ab3cc3e6011f8073433578a2b83d28af (diff) | |
| download | emacs-20ba690ce00c42cc2be78778ba32caba76491b8c.tar.gz emacs-20ba690ce00c42cc2be78778ba32caba76491b8c.zip | |
(msb--many-menus): Remove variable.
(msb-max-menu-items, msb--add-to-menu): Doc fixes.
(msb-menu-cond, msb-item-handling-function, msb--create-function-info)
(msb--toggle-menu-type): Fix typos in docstrings.
| -rw-r--r-- | lisp/msb.el | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/lisp/msb.el b/lisp/msb.el index 11c9cfc4d37..81ad924ccd4 100644 --- a/lisp/msb.el +++ b/lisp/msb.el | |||
| @@ -190,9 +190,6 @@ | |||
| 190 | 3099 | 190 | 3099 |
| 191 | "Other files (%d)"))) | 191 | "Other files (%d)"))) |
| 192 | 192 | ||
| 193 | ;; msb--many-menus is obsolete | ||
| 194 | (defvar msb--many-menus msb--very-many-menus) | ||
| 195 | |||
| 196 | ;;; | 193 | ;;; |
| 197 | ;;; Customizable variables | 194 | ;;; Customizable variables |
| 198 | ;;; | 195 | ;;; |
| @@ -235,12 +232,12 @@ A value of nil means don't display this menu. | |||
| 235 | MENU-TITLE is really a format. If you add %d in it, the %d is | 232 | MENU-TITLE is really a format. If you add %d in it, the %d is |
| 236 | replaced with the number of items in that menu. | 233 | replaced with the number of items in that menu. |
| 237 | 234 | ||
| 238 | ITEM-HANDLING-FN, is optional. If it is supplied and is a function, | 235 | ITEM-HANDLING-FN is optional. If it is supplied and is a function, |
| 239 | than it is used for displaying the items in that particular buffer | 236 | then it is used for displaying the items in that particular buffer |
| 240 | menu, otherwise the function pointed out by | 237 | menu, otherwise the function pointed out by |
| 241 | `msb-item-handling-function' is used. | 238 | `msb-item-handling-function' is used. |
| 242 | 239 | ||
| 243 | ITEM-SORT-FN, is also optional. | 240 | ITEM-SORT-FN is also optional. |
| 244 | If it is not supplied, the function pointed out by | 241 | If it is not supplied, the function pointed out by |
| 245 | `msb-item-sort-function' is used. | 242 | `msb-item-sort-function' is used. |
| 246 | If it is nil, then no sort takes place and the buffers are presented | 243 | If it is nil, then no sort takes place and the buffers are presented |
| @@ -282,7 +279,7 @@ that differs by this value or more." | |||
| 282 | (defcustom msb-max-menu-items 15 | 279 | (defcustom msb-max-menu-items 15 |
| 283 | "*The maximum number of items in a menu. | 280 | "*The maximum number of items in a menu. |
| 284 | If this variable is set to 15 for instance, then the submenu will be | 281 | If this variable is set to 15 for instance, then the submenu will be |
| 285 | split up in minor parts, 15 items each. nil means no limit." | 282 | split up in minor parts, 15 items each. A value of nil means no limit." |
| 286 | :type '(choice integer (const nil)) | 283 | :type '(choice integer (const nil)) |
| 287 | :set 'msb-custom-set | 284 | :set 'msb-custom-set |
| 288 | :group 'msb) | 285 | :group 'msb) |
| @@ -336,7 +333,7 @@ names that starts with a space character." | |||
| 336 | "*The appearance of a buffer menu. | 333 | "*The appearance of a buffer menu. |
| 337 | 334 | ||
| 338 | The default function to call for handling the appearance of a menu | 335 | The default function to call for handling the appearance of a menu |
| 339 | item. It should take to arguments, BUFFER and MAX-BUFFER-NAME-LENGTH, | 336 | item. It should take two arguments, BUFFER and MAX-BUFFER-NAME-LENGTH, |
| 340 | where the latter is the max length of all buffer names. | 337 | where the latter is the max length of all buffer names. |
| 341 | 338 | ||
| 342 | The function should return the string to use in the menu. | 339 | The function should return the string to use in the menu. |
| @@ -664,7 +661,7 @@ If the argument is left out or nil, then the current buffer is considered." | |||
| 664 | (defun msb--create-function-info (menu-cond-elt) | 661 | (defun msb--create-function-info (menu-cond-elt) |
| 665 | "Create a vector from an element MENU-COND-ELT of `msb-menu-cond'. | 662 | "Create a vector from an element MENU-COND-ELT of `msb-menu-cond'. |
| 666 | This takes the form: | 663 | This takes the form: |
| 667 | \]BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER) | 664 | \[BUFFER-LIST-VARIABLE CONDITION MENU-SORT-KEY MENU-TITLE ITEM-HANDLER SORTER] |
| 668 | See `msb-menu-cond' for a description of its elements." | 665 | See `msb-menu-cond' for a description of its elements." |
| 669 | (let* ((list-symbol (make-symbol "-msb-buffer-list")) | 666 | (let* ((list-symbol (make-symbol "-msb-buffer-list")) |
| 670 | (tmp-ih (and (> (length menu-cond-elt) 3) | 667 | (tmp-ih (and (> (length menu-cond-elt) 3) |
| @@ -727,7 +724,7 @@ See `msb-menu-cond' for a description of its elements." | |||
| 727 | (defun msb--add-to-menu (buffer function-info max-buffer-name-length) | 724 | (defun msb--add-to-menu (buffer function-info max-buffer-name-length) |
| 728 | "Add BUFFER to the menu depicted by FUNCTION-INFO. | 725 | "Add BUFFER to the menu depicted by FUNCTION-INFO. |
| 729 | All side-effects. Adds an element of form (BUFFER-TITLE . BUFFER) | 726 | All side-effects. Adds an element of form (BUFFER-TITLE . BUFFER) |
| 730 | to the buffer-list variable in function-info." | 727 | to the buffer-list variable in FUNCTION-INFO." |
| 731 | (let ((list-symbol (aref function-info 0))) ;BUFFER-LIST-VARIABLE | 728 | (let ((list-symbol (aref function-info 0))) ;BUFFER-LIST-VARIABLE |
| 732 | ;; Here comes the hairy side-effect! | 729 | ;; Here comes the hairy side-effect! |
| 733 | (set list-symbol | 730 | (set list-symbol |
| @@ -961,7 +958,7 @@ It takes the form ((TITLE . BUFFER-LIST)...)." | |||
| 961 | (msb--create-buffer-menu-2)))) | 958 | (msb--create-buffer-menu-2)))) |
| 962 | 959 | ||
| 963 | (defun msb--toggle-menu-type () | 960 | (defun msb--toggle-menu-type () |
| 964 | "Multi purpose function for selecting a buffer with the mouse." | 961 | "Multi-purpose function for selecting a buffer with the mouse." |
| 965 | (interactive) | 962 | (interactive) |
| 966 | (setq msb-files-by-directory (not msb-files-by-directory)) | 963 | (setq msb-files-by-directory (not msb-files-by-directory)) |
| 967 | ;; This gets a warning, but it is correct, | 964 | ;; This gets a warning, but it is correct, |