Preparation to begin using phpdocumentor.

[squirrelmail.git] / functions / decode / big5.php

diff --git a/functions/decode/big5.php b/functions/decode/big5.php
index 941b1e6526f816cc373e0cb8be1af90b6a55d909..6a00c39ef5843192b290f88a1c34d3a52bfa5d48 100644 (file)
--- a/functions/decode/big5.php
+++ b/functions/decode/big5.php
@@ -1,17 +1,48 @@
 <?php
 
-/*
+/**
  * decode/big5.php
  * $Id$
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This file contains big5 decoding function that is needed to read
  * big5 encoded mails in non-big5 locale.
+ * 
+ * Original data taken from:
+ *  ftp://ftp.unicode.org/Public/MAPPINGS/OBSOLETE/EASTASIA/OTHER/BIG5.TXT
  *
+ * Name:             BIG5 to Unicode table (complete)
+ * Unicode version:  1.1
+ * Table version:    0.0d3
+ * Table format:     Format A
+ * Date:             11 February 1994
+ *
+ * Copyright (c) 1991-1994 Unicode, Inc.  All Rights reserved.
+ *
+ * This file is provided as-is by Unicode, Inc. (The Unicode Consortium).
+ * No claims are made as to fitness for any particular purpose.  No
+ * warranties of any kind are expressed or implied.  The recipient
+ * agrees to determine applicability of information provided.  If this
+ * file has been provided on magnetic media by Unicode, Inc., the sole
+ * remedy for any claim will be exchange of defective media within 90
+ * days of receipt.
+ *
+ * Recipient is granted the right to make copies in any form for
+ * internal distribution and to freely use the information supplied
+ * in the creation of products supporting Unicode.  Unicode, Inc.
+ * specifically excludes the right to re-distribute this file directly
+ * to third parties or other organizations whether for profit or not.
+ * @package squirrelmail
+ * @subpackage decode
  */
 
+/**
+ * Decode big5 encoded string
+ * @param string $string big5 string
+ * @return string $string decoded string
+ */
 function charset_decode_big5 ($string) {
     global $default_charset;
 
@@ -13740,4 +13771,4 @@ function charset_decode_big5 ($string) {
     return $string;
 }
 
-?>
\ No newline at end of file
+?>