more doxygen doku.

[citadel.git] / webcit / groupdav_put.c

diff --git a/webcit/groupdav_put.c b/webcit/groupdav_put.c
index 79a0da12966f2e824323d840fa4eba27108c633b..e2c91fe727bc8ba2b25cfac32dd753edc7e6822f 100644 (file)
--- a/webcit/groupdav_put.c
+++ b/webcit/groupdav_put.c
@@ -1,17 +1,22 @@
 /*
  * $Id$
- *
- * Handles GroupDAV PUT requests.
+ */
+/**
+ * \defgroup GroupdavPut Handles GroupDAV PUT requests.
  *
  */
-
+/*@{*/
 #include "webcit.h"
 #include "webserver.h"
 #include "groupdav.h"
 
 
-/*
- * The pathname is always going to be /groupdav/room_name/euid
+/**
+ * \brief put an item to the server
+ * \param dav_pathname The pathname is always going to be /groupdav/room_name/euid
+ * \param dav_ifmatch should we match?
+ * \param dav_content_type the mime type
+ * \param dav_content the actual data
  */
 void groupdav_put(char *dav_pathname, char *dav_ifmatch,
                char *dav_content_type, char *dav_content
@@ -23,22 +28,22 @@ void groupdav_put(char *dav_pathname, char *dav_ifmatch,
        char buf[SIZ];
        int n = 0;
 
-       /* First, break off the "/groupdav/" prefix */
+       /** First, break off the "/groupdav/" prefix */
        remove_token(dav_pathname, 0, '/');
        remove_token(dav_pathname, 0, '/');
 
-       /* Now extract the message euid */
+       /** Now extract the message euid */
        n = num_tokens(dav_pathname, '/');
        extract_token(dav_uid, dav_pathname, n-1, '/', sizeof dav_uid);
        remove_token(dav_pathname, n-1, '/');
 
-       /* What's left is the room name.  Remove trailing slashes. */
+       /** What's left is the room name.  Remove trailing slashes. */
        if (dav_pathname[strlen(dav_pathname)-1] == '/') {
                dav_pathname[strlen(dav_pathname)-1] = 0;
        }
        strcpy(dav_roomname, dav_pathname);
 
-       /* Go to the correct room. */
+       /** Go to the correct room. */
        if (strcasecmp(WC->wc_roomname, dav_roomname)) {
                gotoroom(dav_roomname);
        }
@@ -54,7 +59,7 @@ void groupdav_put(char *dav_pathname, char *dav_ifmatch,
                return;
        }
 
-       /*
+       /**
         * If an HTTP If-Match: header is present, the client is attempting
         * to replace an existing item.  We have to check to see if the
         * message number associated with the supplied uid matches what the
@@ -73,7 +78,7 @@ void groupdav_put(char *dav_pathname, char *dav_ifmatch,
                }
        }
 
-       /*
+       /**
         * We are cleared for upload!  We use the new calling syntax for ENT0
         * which allows a confirmation to be sent back to us.  That's how we
         * extract the message ID.
@@ -90,12 +95,12 @@ void groupdav_put(char *dav_pathname, char *dav_ifmatch,
                return;
        }
 
-       /* Send the content to the Citadel server */
+       /** Send the content to the Citadel server */
        serv_printf("Content-type: %s\n\n", dav_content_type);
        serv_puts(dav_content);
        serv_puts("\n000");
 
-       /* Fetch the reply from the Citadel server */
+       /** Fetch the reply from the Citadel server */
        n = 0;
        strcpy(dav_uid, "");
        while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
@@ -111,9 +116,9 @@ void groupdav_put(char *dav_pathname, char *dav_ifmatch,
                }
        }
 
-       /* Tell the client what happened. */
+       /** Tell the client what happened. */
 
-       /* Citadel failed in some way? */
+       /** Citadel failed in some way? */
        if (new_msgnum < 0L) {
                wprintf("HTTP/1.1 502 Bad Gateway\r\n");
                groupdav_common_headers();
@@ -125,7 +130,7 @@ void groupdav_put(char *dav_pathname, char *dav_ifmatch,
                return;
        }
 
-       /* We created this item for the first time. */
+       /** We created this item for the first time. */
        if (old_msgnum < 0L) {
                wprintf("HTTP/1.1 201 Created\r\n");
                lprintf(9, "HTTP/1.1 201 Created\r\n");
@@ -145,14 +150,15 @@ void groupdav_put(char *dav_pathname, char *dav_ifmatch,
                return;
        }
 
-       /* We modified an existing item. */
+       /** We modified an existing item. */
        wprintf("HTTP/1.1 204 No Content\r\n");
        lprintf(9, "HTTP/1.1 204 No Content\r\n");
        groupdav_common_headers();
        wprintf("etag: \"%ld\"\r\n", new_msgnum);
        wprintf("Content-Length: 0\r\n\r\n");
 
-       /* The item we replaced has probably already been deleted by
+       /**
+        * The item we replaced has probably already been deleted by
         * the Citadel server, but we'll do this anyway, just in case.
         */
        serv_printf("DELE %ld", old_msgnum);
@@ -160,3 +166,6 @@ void groupdav_put(char *dav_pathname, char *dav_ifmatch,
 
        return;
 }
+
+
+/*@}*/