removed local directory name used for testing.

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

diff --git a/class/mime/ContentType.class.php b/class/mime/ContentType.class.php
index 9653b58f1d0a85788f1935619d711a36a5f5ecc9..d44c79f9ccf4fd8baa11a033fea1dbd463087d9a 100644 (file)
--- a/class/mime/ContentType.class.php
+++ b/class/mime/ContentType.class.php
@@ -6,21 +6,46 @@
  * Copyright (c) 2003-2005 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- * This contains functions needed to handle mime messages.
+ * This file contains functions needed to handle content type headers 
+ * (rfc2045) in mime messages.
  *
  * @version $Id$
  * @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.2
  */
 
 /**
- * Undocumented class
+ * 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) {