Updating documentation

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@10256 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/class/mime/AddressStructure.class.php b/class/mime/AddressStructure.class.php
index 56dae5338ddfe1cc6b657d5a7fb1a554366c1045..96524e340fb01d6a8a32ece44330d25f2ee38b50 100644 (file)
--- a/class/mime/AddressStructure.class.php
+++ b/class/mime/AddressStructure.class.php
@@ -3,7 +3,7 @@
 /**
  * AddressStructure.class.php
  *
- * This file contains functions needed to extract email address headers from 
+ * This file contains functions needed to extract email address headers from
  * mime messages.
  *
  * @copyright © 2003-2005 The SquirrelMail Project Team
@@ -49,7 +49,7 @@ class AddressStructure {
 
     /**
      * Return address information from mime headers.
-     * @param boolean $full return full address (true) or only email (false)
+     * @param boolean $full return full address (true) or only personal if it exists, otherwise email (false)
      * @param boolean $encoded (since 1.4.0) return rfc2047 encoded address (true) or plain text (false).
      * @return string
      */
@@ -98,4 +98,5 @@ class AddressStructure {
         return $this->getAddress(true, true);
     }
 }
+
 ?>
\ No newline at end of file