diff lisp/gutter-items.el @ 1362:cfe4bcb9bdd4

[xemacs-hg @ 2003-03-18 06:58:19 by stephent] wid-edit.el cleanup <878yvdi2rz.fsf@tleepslib.sk.tsukuba.ac.jp> buffers tab control doc improvements <87bs09i3w5.fsf_-_@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Tue, 18 Mar 2003 06:58:24 +0000
parents 3508e2f71814
children 16b17fd1dc93
line wrap: on
line diff
--- a/lisp/gutter-items.el	Tue Mar 18 00:54:00 2003 +0000
+++ b/lisp/gutter-items.el	Tue Mar 18 06:58:24 2003 +0000
@@ -110,12 +110,16 @@
 			"Set `buffers-tab-filter-functions' instead.")
 
 (defcustom buffers-tab-filter-functions (list 'select-buffers-tab-buffers-by-mode)
-  "*If non-nil, a list of functions specifying the buffers to include
-in the buffers tab, depending on the context.
-Each function in the list is passed two buffers, the buffer to
-potentially select and the context buffer, and should return non-nil
-if the first buffer should be selected.  The default value groups
-buffers by major mode and by `buffers-tab-grouping-regexp'."
+  "*A list of functions specifying buffers to display in the buffers tab.
+
+If nil, all buffers are kept, up to `buffers-tab-max-size', in usual order.
+Otherwise, each function in the list must take arguments (BUF1 BUF2).
+BUF1 is the candidate, and BUF2 is the current buffer (first in the buffers
+list).  The function should return non-nil if BUF1 should be added to the
+buffers tab.  BUF1 will be omitted if any of the functions returns nil.
+
+Defaults to `select-buffers-tab-buffers-by-mode', which adds BUF1 if BUF1 and
+BUF2 have the same major mode, or both match `buffers-tab-grouping-regexp'."
 
   :type '(repeat function)
   :group 'buffers-tab)