Minor fix
[squirrelmail.git] / class / mime / Disposition.class.php
index 38f8d292d086cbff35f7a2e3ced0367e63c304d3..6020c91588216d9c0ffc8003cac25dd89ecb5a34 100644 (file)
@@ -3,25 +3,40 @@
 /**
  * Disposition.class.php
  *
- * Copyright (c) 2003-2004 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 disposition headers 
+ * in mime messages. See RFC 2183.
  *
+ * @copyright 2003-2015 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
  */
 
 /**
- * Undocumented class
+ * Class that handles content disposition header
  * @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.0
+ * @todo FIXME: do we have to declare vars ($name and $properties)?
  */
 class Disposition {
+    /**
+     * Constructor function
+     * @param string $name
+     */
     function Disposition($name) {
        $this->name = $name;
        $this->properties = array();
     }
 
+    /**
+     * Returns value of content disposition property
+     * @param string $par content disposition property name
+     * @return string
+     * @since 1.3.1
+     */
     function getProperty($par) {
         $value = strtolower($par);
         if (isset($this->properties[$par])) {
@@ -30,5 +45,3 @@ class Disposition {
         return '';
     }
 }
-
-?>