Done with doxygenizing

[citadel.git] / webcit / vcard.h

diff --git a/webcit/vcard.h b/webcit/vcard.h
index c8fbcfec8a3b4c580ada3605a37eb2d64ebb955a..fa8ce33bd136efdcbe9705d3512d78d6cb92b07e 100644 (file)
--- a/webcit/vcard.h
+++ b/webcit/vcard.h
@@ -1,26 +1,27 @@
 /*
  * $Id$
- *
- * vCard implementation for Citadel
+ */
+/**
+ * \defgroup VcardHeader vCard implementation for Citadel
  *
  * Copyright (C) 1999 by Art Cancro
  * This code is freely redistributable under the terms of the GNU General
  * Public License.  All other rights reserved.
  */
 
+/*@{ */
+#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??? */
 };
 
 
@@ -31,3 +32,6 @@ 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 return_propname);
 char *vcard_serialize(struct vCard *);
+
+
+/*@}*/