adding phpdoc comments

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

diff --git a/class/helper/VCard.class.php b/class/helper/VCard.class.php
index 5be02b3f2c30a26616cf49b8293daa0fd5e9094e..898fe0b47d42cc9c2220604d2f5d4821132c6fa0 100644 (file)
--- a/class/helper/VCard.class.php
+++ b/class/helper/VCard.class.php
@@ -12,24 +12,33 @@
  *
  * @version $Id$
  * @package squirrelmail
+ * @since 1.3.2
  */
 
 /**
- * Undocumented class
+ * Unimplemented class that should handle vcards
+ * Don't use it unless it is marked as implemented.
  * @package squirrelmail
  */
 class VCard {
-
-function create_vcard ($value_array) {
-
-return $vcard;
-}
-
-function parse_vcard ($vcard) {
-
-return $array;
-}
-
+    /**
+     * Create vcard from information stored in array
+     * @todo implement vcard creation from array
+     * @param array $value_array
+     * @return string
+     */
+    function create_vcard ($value_array) {
+        return $vcard;
+    }
+
+    /**
+     * Read vcard and convert it to array
+     * @todo implement vcard parsing
+     * @param string $vcard
+     * @return array
+     */
+    function parse_vcard ($vcard) {
+        return $array;
+    }
 }
-
 ?>
\ No newline at end of file