more doxygen doku.

[citadel.git] / webcit / groupdav_main.c

diff --git a/webcit/groupdav_main.c b/webcit/groupdav_main.c
index ba5817d0f7b97c67bd2513776fe149154d090b8e..793f9651071c3728c9831ef59455354e08e322a2 100644 (file)
--- a/webcit/groupdav_main.c
+++ b/webcit/groupdav_main.c
@@ -1,17 +1,18 @@
 /*
  * $Id$
- *
- * Entry point for GroupDAV functions
+ */
+/**
+ * \defgroup GroupdavMain Entry point for GroupDAV functions
  *
  */
-
+/*@{*/
 #include "webcit.h"
 #include "webserver.h"
 #include "groupdav.h"
 
 
-/*
- * Output HTTP headers which are common to all requests.
+/**
+ * \brief Output HTTP headers which are common to all requests.
  *
  * Please observe that we don't use the usual output_headers()
  * and wDumpContent() functions in the GroupDAV subsystem, so we
@@ -28,8 +29,10 @@ void groupdav_common_headers(void) {
 
 
 
-/*
- * string conversion function
+/**
+ * \brief string conversion function
+ * \param target output string
+ * \param source string to process
  */
 void euid_escapize(char *target, char *source) {
        int i;
@@ -56,8 +59,10 @@ void euid_escapize(char *target, char *source) {
        }
 }
 
-/*
- * string conversion function
+/**
+ * \brief string conversion function
+ * \param target output string
+ * \param source string to process
  */
 void euid_unescapize(char *target, char *source) {
        int a, b;
@@ -95,8 +100,12 @@ void euid_unescapize(char *target, char *source) {
 
 
 
-/*
- * Main entry point for GroupDAV requests
+/**
+ * \brief Main entry point for GroupDAV requests
+ * \param req Request header
+ * \param dav_content_type the kind of dav elemet to represent??
+ * \param dav_content_length the length of our response
+ * \param dav_content the actual content to give back
  */
 void groupdav_main(struct httprequest *req,
                        char *dav_content_type,
@@ -140,7 +149,8 @@ void groupdav_main(struct httprequest *req,
        extract_token(dav_pathname, req->line, 1, ' ', sizeof dav_pathname);
        unescape_input(dav_pathname);
 
-       /* If the request does not begin with "/groupdav", prepend it.  If
+       /**
+        * If the request does not begin with "/groupdav", prepend it.  If
         * we happen to introduce a double-slash, that's ok; we'll strip it
         * in the next step.
         */
@@ -149,12 +159,12 @@ void groupdav_main(struct httprequest *req,
                safestrncpy(dav_pathname, buf, sizeof dav_pathname);
        }
        
-       /* Remove any stray double-slashes in pathname */
+       /** Remove any stray double-slashes in pathname */
        while (ds=strstr(dav_pathname, "//"), ds != NULL) {
                strcpy(ds, ds+1);
        }
 
-       /*
+       /**
         * If there's an If-Match: header, strip out the quotes if present, and
         * then if all that's left is an asterisk, make it go away entirely.
         */
@@ -173,7 +183,7 @@ void groupdav_main(struct httprequest *req,
                }
        }
 
-       /*
+       /**
         * The OPTIONS method is not required by GroupDAV.  This is an
         * experiment to determine what might be involved in supporting
         * other variants of DAV in the future.
@@ -183,7 +193,7 @@ void groupdav_main(struct httprequest *req,
                return;
        }
 
-       /*
+       /**
         * The PROPFIND method is basically used to list all objects in a
         * room, or to list all relevant rooms on the server.
         */
@@ -192,7 +202,7 @@ void groupdav_main(struct httprequest *req,
                return;
        }
 
-       /*
+       /**
         * The GET method is used for fetching individual items.
         */
        if (!strcasecmp(dav_method, "GET")) {
@@ -200,7 +210,7 @@ void groupdav_main(struct httprequest *req,
                return;
        }
 
-       /*
+       /**
         * The PUT method is used to add or modify items.
         */
        if (!strcasecmp(dav_method, "PUT")) {
@@ -209,7 +219,7 @@ void groupdav_main(struct httprequest *req,
                return;
        }
 
-       /*
+       /**
         * The DELETE method kills, maims, and destroys.
         */
        if (!strcasecmp(dav_method, "DELETE")) {
@@ -217,7 +227,7 @@ void groupdav_main(struct httprequest *req,
                return;
        }
 
-       /*
+       /**
         * Couldn't find what we were looking for.  Die in a car fire.
         */
        wprintf("HTTP/1.1 501 Method not implemented\r\n");
@@ -228,3 +238,6 @@ void groupdav_main(struct httprequest *req,
                dav_method
        );
 }
+
+
+/*@}*/