fixed phpdoc formating. require() call loaded before first phpdoc block.

[squirrelmail.git] / class / mime / ContentType.class.php

diff --git a/class/mime/ContentType.class.php b/class/mime/ContentType.class.php
index 85f24ab761fe3274d1ee88d8c57444772870cd81..be8761554ee97dfc271a0492c94e9991416aa54c 100644 (file)
--- a/class/mime/ContentType.class.php
+++ b/class/mime/ContentType.class.php
@@ -3,19 +3,48 @@
 /**
  * ContentType.class.php
  *
- * Copyright (c) 2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * This file contains functions needed to handle content type headers 
+ * (rfc2045) in mime messages.
  *
- * This contains functions needed to handle mime messages.
- *
- * $Id$
+ * @copyright © 2003-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.2
  */
 
+/**
+ * Class that handles content-type headers
+ * Class was named content_type in 1.3.0 and 1.3.1. It is used internally
+ * by rfc822header class.
+ * @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.2
+ */
 class ContentType {
-    var $type0      = 'text',
-        $type1      = 'plain',
-        $properties = '';
+    /**
+     * Media type
+     * @var string
+     */
+    var $type0 = 'text';
+    /**
+     * Media subtype
+     * @var string
+     */
+    var $type1 = 'plain';
+    /**
+     * Auxiliary header information
+     * prepared with parseContentType() function in rfc822header class.
+     * @var array
+     */
+    var $properties = '';
 
+    /**
+     * Constructor function.
+     * Prepared type0 and type1 properties
+     * @param string $type content type string without auxiliary information
+     */
     function ContentType($type) {
         $pos = strpos($type, '/');
         if ($pos > 0) {
@@ -27,5 +56,3 @@ class ContentType {
         $this->properties = array();
     }
 }
-
-?>