phpdoc block

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

diff --git a/functions/encode/utf_8.php b/functions/encode/utf_8.php
index 7a87e92bac5e81667b7b26967a42d3e2e0db7c1e..ae73daec0bbb655474694f140d307ba5d1a47d32 100644 (file)
--- a/functions/encode/utf_8.php
+++ b/functions/encode/utf_8.php
@@ -1,12 +1,20 @@
 <?php
 /**
-* takes a string of unicode entities and converts it to a utf-8 encoded string
-* each unicode entitiy has the form &#nnn(nn); n={0..9} and can be displayed by utf-8 supporting
-* browsers.  Ascii will not be modified.
-* @param $source string of unicode entities [STRING]
-* @return a utf-8 encoded string [STRING]
-* @access public
-*/
+ * utf-8 encoding function
+ *
+ * takes a string of unicode entities and converts it to a utf-8 encoded string
+ * each unicode entitiy has the form &#nnn(nn); n={0..9} and can be displayed by utf-8 supporting
+ * browsers.  Ascii will not be modified.
+ *
+ * code is taken from www.php.net manual comments
+ * Author: ronen at greyzone dot com
+ *
+ * @package squirrelmail
+ * @subpackage encode
+ * @param $source string of unicode entities [STRING]
+ * @return a utf-8 encoded string [STRING]
+ * @access public
+ */
 function charset_encode_utf_8 ($source) {
    $utf8Str = '';
    $entityArray = explode ("&#", $source);