changeset 55509:dbf692d994dc

(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).
author Juanma Barranquero <lekktu@gmail.com>
date Mon, 10 May 2004 18:13:07 +0000
parents 44124e158456
children 2b15e893127e
files lisp/ibuf-macs.el
diffstat 1 files changed, 12 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/ibuf-macs.el	Mon May 10 17:58:20 2004 +0000
+++ b/lisp/ibuf-macs.el	Mon May 10 18:13:07 2004 +0000
@@ -93,7 +93,9 @@
 ibuffer-make-column-NAME.  If INLINE is non-nil, then the form will be
 inlined into the compiled format versions.  This means that if you
 change its definition, you should explicitly call
-`ibuffer-recompile-formats'."
+`ibuffer-recompile-formats'.
+
+\(fn SYMBOL (&key NAME INLINE PROPS SUMMARIZER) &rest BODY)"
   (let* ((sym (intern (concat "ibuffer-make-column-"
 			      (symbol-name symbol))))
 	 (bod-1 `(with-current-buffer buffer
@@ -135,7 +137,9 @@
 
 For sorting, the forms in BODY will be evaluated with `a' bound to one
 buffer object, and `b' bound to another.  BODY should return a non-nil
-value if and only if `a' is \"less than\" `b'."
+value if and only if `a' is \"less than\" `b'.
+
+\(fn NAME DOCUMENTATION (&key DESCRIPTION) &rest BODY)"
   `(progn
      (defun ,(intern (concat "ibuffer-do-sort-by-" (symbol-name name))) ()
        ,(or documentation "No :documentation specified for this sorting method.")
@@ -189,7 +193,9 @@
 confirmation message, in the form:
  \"Really ACTIVE-OPSTRING x buffers?\"
 COMPLEX means this function is special; see the source code of this
-macro for exactly what it does."
+macro for exactly what it does.
+
+\(fn OP ARGS DOCUMENTATION (&key INTERACTIVE MARK MODIFIER-P DANGEROUS OPSTRING ACTIVE-OPSTRING COMPLEX) &rest BODY)"
   `(progn
     (defun ,(intern (concat (if (string-match "^ibuffer-do" (symbol-name op))
 				"" "ibuffer-do-") (symbol-name op)))
@@ -265,7 +271,9 @@
 BODY should contain forms which will be evaluated to test whether or
 not a particular buffer should be displayed or not.  The forms in BODY
 will be evaluated with BUF bound to the buffer object, and QUALIFIER
-bound to the current value of the filter."
+bound to the current value of the filter.
+
+\(fn NAME DOCUMENTATION (&key READER DESCRIPTION) &rest BODY)"
   (let ((fn-name (intern (concat "ibuffer-filter-by-" (symbol-name name)))))
     `(progn
        (defun ,fn-name (qualifier)