From: shuhei <shuhei>
Date: Sun, 22 Apr 2001 02:27:07 +0000 (+0000)
Subject: (mime-parse-Content-Disposition): Add description of return value to the docstring.
X-Git-Url: http://git.chise.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e84f30d8650abf88589b9c9eae3abc1c24922bbc;p=elisp%2Fflim.git

(mime-parse-Content-Disposition): Add description of return value to the docstring.
(mime-parse-Content-Transfer-Encoding): Ditto.
---

diff --git a/mime-parse.el b/mime-parse.el
index bc2d9c2..9cebfda 100644
--- a/mime-parse.el
+++ b/mime-parse.el
@@ -394,7 +394,16 @@ Format of return value is same as that of `mime-parse-Content-Type'."
 
 ;;;###autoload
 (defun mime-parse-Content-Disposition (field-body)
-  "Parse FIELD-BODY as Content-Disposition field.  FIELD-BODY is a string."
+  "Parse FIELD-BODY as Content-Disposition field.  FIELD-BODY is a string.
+
+Return value is
+
+    ((type . DISPOSITION-TYPE)
+     (ATTRIBUTE1 . VALUE1)(ATTRIBUTE2 . VALUE2) ...)
+
+or nil.
+
+DISPOSITION-TYPE is a symbol, and other elements are strings."
   (let ((tokens (mime-lexical-analyze field-body)))
     (when (eq (car (car tokens)) 'mime-token)
       (make-mime-content-disposition
@@ -416,7 +425,8 @@ Format of return value is same as that of `mime-parse-Content-Type'."
 
 ;;;###autoload
 (defun mime-parse-Content-Transfer-Encoding (field-body)
-  "Parse FIELD-BODY as Content-Transfer-Encoding field.  FIELD-BODY is a string."
+  "Parse FIELD-BODY as Content-Transfer-Encoding field.  FIELD-BODY is a string.
+Return value is a string."
   (let ((tokens (mime-lexical-analyze field-body)))
     (when (eq (car (car tokens)) 'mime-token)
       (downcase (cdr (car tokens))))))