aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorJuanma Barranquero2004-05-10 18:13:07 +0000
committerJuanma Barranquero2004-05-10 18:13:07 +0000
commit9bb69f4500a261251279bcf9ee69ec20cea802c3 (patch)
tree44d3c3e4c58427e4c79bb1d1633ac4f9a43c77ab /lisp
parent1074a8812ce0ed811327fb56c06f9e8b57210c94 (diff)
downloademacs-9bb69f4500a261251279bcf9ee69ec20cea802c3.tar.gz
emacs-9bb69f4500a261251279bcf9ee69ec20cea802c3.zip
(define-ibuffer-column, define-ibuffer-sorter, define-ibuffer-filter): Add usage
info. (define-ibuffer-op): Add usage info (but CL-style defaults for keyword args are not shown).
Diffstat (limited to 'lisp')
-rw-r--r--lisp/ibuf-macs.el16
1 files changed, 12 insertions, 4 deletions
diff --git a/lisp/ibuf-macs.el b/lisp/ibuf-macs.el
index d6b4c2e1da8..effcafd9240 100644
--- a/lisp/ibuf-macs.el
+++ b/lisp/ibuf-macs.el
@@ -93,7 +93,9 @@ Note that this macro expands into a `defun' for a function named
93ibuffer-make-column-NAME. If INLINE is non-nil, then the form will be 93ibuffer-make-column-NAME. If INLINE is non-nil, then the form will be
94inlined into the compiled format versions. This means that if you 94inlined into the compiled format versions. This means that if you
95change its definition, you should explicitly call 95change its definition, you should explicitly call
96`ibuffer-recompile-formats'." 96`ibuffer-recompile-formats'.
97
98\(fn SYMBOL (&key NAME INLINE PROPS SUMMARIZER) &rest BODY)"
97 (let* ((sym (intern (concat "ibuffer-make-column-" 99 (let* ((sym (intern (concat "ibuffer-make-column-"
98 (symbol-name symbol)))) 100 (symbol-name symbol))))
99 (bod-1 `(with-current-buffer buffer 101 (bod-1 `(with-current-buffer buffer
@@ -135,7 +137,9 @@ DESCRIPTION is a short string describing the sorting method.
135 137
136For sorting, the forms in BODY will be evaluated with `a' bound to one 138For sorting, the forms in BODY will be evaluated with `a' bound to one
137buffer object, and `b' bound to another. BODY should return a non-nil 139buffer object, and `b' bound to another. BODY should return a non-nil
138value if and only if `a' is \"less than\" `b'." 140value if and only if `a' is \"less than\" `b'.
141
142\(fn NAME DOCUMENTATION (&key DESCRIPTION) &rest BODY)"
139 `(progn 143 `(progn
140 (defun ,(intern (concat "ibuffer-do-sort-by-" (symbol-name name))) () 144 (defun ,(intern (concat "ibuffer-do-sort-by-" (symbol-name name))) ()
141 ,(or documentation "No :documentation specified for this sorting method.") 145 ,(or documentation "No :documentation specified for this sorting method.")
@@ -189,7 +193,9 @@ ACTIVE-OPSTRING is a string which will be displayed to the user in a
189confirmation message, in the form: 193confirmation message, in the form:
190 \"Really ACTIVE-OPSTRING x buffers?\" 194 \"Really ACTIVE-OPSTRING x buffers?\"
191COMPLEX means this function is special; see the source code of this 195COMPLEX means this function is special; see the source code of this
192macro for exactly what it does." 196macro for exactly what it does.
197
198\(fn OP ARGS DOCUMENTATION (&key INTERACTIVE MARK MODIFIER-P DANGEROUS OPSTRING ACTIVE-OPSTRING COMPLEX) &rest BODY)"
193 `(progn 199 `(progn
194 (defun ,(intern (concat (if (string-match "^ibuffer-do" (symbol-name op)) 200 (defun ,(intern (concat (if (string-match "^ibuffer-do" (symbol-name op))
195 "" "ibuffer-do-") (symbol-name op))) 201 "" "ibuffer-do-") (symbol-name op)))
@@ -265,7 +271,9 @@ DESCRIPTION is a short string describing the filter.
265BODY should contain forms which will be evaluated to test whether or 271BODY should contain forms which will be evaluated to test whether or
266not a particular buffer should be displayed or not. The forms in BODY 272not a particular buffer should be displayed or not. The forms in BODY
267will be evaluated with BUF bound to the buffer object, and QUALIFIER 273will be evaluated with BUF bound to the buffer object, and QUALIFIER
268bound to the current value of the filter." 274bound to the current value of the filter.
275
276\(fn NAME DOCUMENTATION (&key READER DESCRIPTION) &rest BODY)"
269 (let ((fn-name (intern (concat "ibuffer-filter-by-" (symbol-name name))))) 277 (let ((fn-name (intern (concat "ibuffer-filter-by-" (symbol-name name)))))
270 `(progn 278 `(progn
271 (defun ,fn-name (qualifier) 279 (defun ,fn-name (qualifier)