From: hmurata <hmurata>
Date: Wed, 8 Nov 2006 00:03:11 +0000 (+0000)
Subject: Update doc-string.
X-Git-Tag: wl-2_15_6-fixes~117
X-Git-Url: http://git.chise.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=10cf04cf5e0c37fbac7206b678340ce0d2c259ec;p=elisp%2Fwanderlust.git

Update doc-string.
---

diff --git a/elmo/elmo-util.el b/elmo/elmo-util.el
index 12dfe07..1254e5d 100644
--- a/elmo/elmo-util.el
+++ b/elmo/elmo-util.el
@@ -1235,8 +1235,13 @@ If optional DELETE-FUNCTION is speficied, it is used as delete procedure."
 	(setq elmo-progress-counter t)))))
 
 (defmacro elmo-with-progress-display (spec message &rest body)
-  "Evaluate BODY with progress message.
-SPEC is a list as followed (LABEL TOTAL [VAR])."
+  "Evaluate BODY with progress message and return its value.
+SPEC is a list as followed (LABEL TOTAL [VAR]).
+LABEL is an identifier what is specidied by `elmo-progress-notify'.
+If TOTAL is nil, the first `elmo-progress-notify' call must be
+with a `:total' parameter.
+If optional parameter VAR is specified, it bind a progress counter object.
+MESSAGE is a doing part of progress message."
   (let ((label (nth 0 spec))
 	(total (nth 1 spec))
 	(var (or (nth 2 spec) (make-symbol "--elmo-progress-temp--"))))