From: morioka <morioka>
Date: Mon, 31 Aug 1998 11:04:48 +0000 (+0000)
Subject: (eword-encode-string): Add DOC-string.
X-Git-Tag: flim-1_9_1~23
X-Git-Url: http://git.chise.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=16338ef0cca198effbce7bf25e5034678c0facf1;p=elisp%2Fflim.git

(eword-encode-string): Add DOC-string.
(eword-encode-address-list): Likewise.
(eword-encode-structured-field-body): Likewise.
---

diff --git a/eword-encode.el b/eword-encode.el
index 98c462e..21bdbfd 100644
--- a/eword-encode.el
+++ b/eword-encode.el
@@ -516,25 +516,34 @@ MODE is allows `text', `comment', `phrase' or nil.  Default value is
 	  ))
     dest))
 
+
+;;; @ application interfaces
+;;;
+
+(defun eword-encode-string (string &optional column mode)
+  "Encode STRING as encoded-words, and return the result.
+Optional argument COLUMN is start-position of the field.
+Optional argument MODE allows `text', `comment', `phrase' or nil.
+Default value is `phrase'."
+  (car (tm-eword::encode-rwl (or column 0)
+			     (tm-eword::split-string string mode))))
+
 (defun eword-encode-address-list (string &optional column)
+  "Encode header field STRING as list of address, and return the result.
+Optional argument COLUMN is start-position of the field."
   (car (tm-eword::encode-rwl
 	(or column 0)
 	(tm-eword::addresses-to-rwl (std11-parse-addresses-string string))
 	)))
 
 (defun eword-encode-structured-field-body (string &optional column)
+  "Encode header field STRING as structured field, and return the result.
+Optional argument COLUMN is start-position of the field."
   (car (tm-eword::encode-rwl
 	(or column 0)
 	(eword-addr-seq-to-rwl (std11-lexical-analyze string))
 	)))
 
-
-;;; @ application interfaces
-;;;
-
-(defun eword-encode-string (str &optional column mode)
-  (car (tm-eword::encode-rwl (or column 0) (tm-eword::split-string str mode))))
-
 (defun eword-encode-field (string)
   "Encode header field STRING, and return the result.
 A lexical token includes non-ASCII character is encoded as MIME