(gnus-extract-address-components): Added doc-string.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 561532d..a12ecf5 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2003-06-17  Reiner Steib  <Reiner.Steib@gmx.de>
+
+       * gnus-util.el (gnus-extract-address-components): Added
+       doc-string.
+
 2003-06-16  Kai Gro\e,A_\e(Bjohann  <kai.grossjohann@gmx.net>
 
        * nnml.el (nnml-current-group-article-to-file-alist): Don't read

diff --git a/lisp/gnus-util.el b/lisp/gnus-util.el
index acbf843..6997c75 100644 (file)
--- a/lisp/gnus-util.el
+++ b/lisp/gnus-util.el
@@ -170,6 +170,11 @@
       (cons 'progn (cddr fval)))))
 
 (defun gnus-extract-address-components (from)
+  "Extract address components from a From header.
+Given an RFC-822 address FROM, extract full name and canonical address.
+Returns a list of the form (FULL-NAME CANONICAL-ADDRESS).  Much more simple
+solution than `mail-extract-address-components', which works much better, but
+is slower."
   (let (name address)
     ;; First find the address - the thing with the @ in it.  This may
     ;; not be accurate in mail addresses, but does the trick most of