Added phpdoc tags to two functions

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

diff --git a/functions/i18n.php b/functions/i18n.php
index 3d99ed0690253bba2e694310d8c7161a30a71720..7c99aface939fbf4272fd2f53bfacbb6d9b81348 100644 (file)
--- a/functions/i18n.php
+++ b/functions/i18n.php
@@ -779,10 +779,16 @@ function korean_charset_xtra() {
     return $ret;
 }
 
-/* 
+/**
+ * Replaces non-braking spaces inserted by some browsers with regular space
+ * 
  * This function can be used to replace non-braking space symbols 
  * that are inserted in forms by some browsers instead of normal 
  * space symbol.
+ *
+ * @param string $string Text that needs to be cleaned
+ * @param string $charset Charset used in text
+ * @return string Cleaned text
  */
 function cleanup_nbsp($string,$charset) {
 
@@ -822,6 +828,15 @@ endswitch;
  return str_replace($nbsp,' ',$string);
 }
 
+/**
+ * Function informs if it is safe to convert given charset to the one that is used by user.
+ *
+ * It is safe to use conversion only if user uses utf-8 encoding and when 
+ * converted charset is similar to the one that is used by user.
+ *
+ * @param string $input_charset Charset of text that needs to be converted
+ * @return bool is it possible to convert to user's charset
+ */
 function is_conversion_safe($input_charset) {
   global $languages, $sm_notAlias, $default_charset;