* Doxygen groups. Sorted the files into groups. so now we have a nice structure

[citadel.git] / webcit / vcard.h

diff --git a/webcit/vcard.h b/webcit/vcard.h
index 743efa99063c2c415d8167f74239af4b74a54e31..af39edbea37a9c018bc4152a1389494c4045a268 100644 (file)
--- a/webcit/vcard.h
+++ b/webcit/vcard.h
@@ -1,26 +1,28 @@
 /*
  * $Id$
- *
- * vCard implementation for Citadel/UX
- *
  * Copyright (C) 1999 by Art Cancro
  * This code is freely redistributable under the terms of the GNU General
  * Public License.  All other rights reserved.
  */
+/**
+ * \defgroup VcardHeader vCard implementation for Citadel
+ * \ingroup WebcitDisplayItems
+ *
+ */
 
+/*@{ */
+#define CTDL_VCARD_MAGIC       0xa1f9 /**< magic byte vcards start with??? */
 
-#define CTDL_VCARD_MAGIC       0xa1f9
-
-/*
- * This data structure represents a vCard object currently in memory.
+/**
+ * \brief This data structure represents a vCard object currently in memory.
  */
 struct vCard {
-       int magic;
-       int numprops;
-       struct vCardProp {
-               char *name;
-               char *value;
-       } *prop;
+       int magic;          /**< the Magic Byte */
+       int numprops;       /**< number of properties this vcard will have */
+       struct vCardProp {  
+               char *name;         /**< Keyname of the property */
+               char *value;        /**< value of the property */
+       } *prop;            /**< Vcard Property. Linked list??? */
 };
 
 
@@ -29,5 +31,8 @@ struct vCard *vcard_load(char *);
 void vcard_free(struct vCard *);
 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
-                       int instance);
+                       int instance, int return_propname);
 char *vcard_serialize(struct vCard *);
+
+
+/*@}*/