Done with doxygenizing

[citadel.git] / webcit / serv_func.c

diff --git a/webcit/serv_func.c b/webcit/serv_func.c
index 2fc570fe4367fe54a31d240e3ade6a55e7fc4206..00024976c9d45955be657e5700ebca8c4956604e 100644 (file)
--- a/webcit/serv_func.c
+++ b/webcit/serv_func.c
@@ -1,24 +1,28 @@
 /*
  * $Id$
- *
- * Handles various types of data transfer operations with the Citadel service.
+ */
+/**
+ * \defgroup ServFuncs Handles various types of data transfer operations with the Citadel service.
  *
  */
 
+/*@{*/ 
 #include "webcit.h"
 #include "webserver.h"
 
-struct serv_info serv_info;
+struct serv_info serv_info; /**< our connection data to the server */
 
-/*
- * get info about the server we've connected to
+/**
+ * \brief get info about the server we've connected to
+ * \param browser_host the citadell we want to connect to
+ * \param user_agent which browser uses our client?
  */
 void get_serv_info(char *browser_host, char *user_agent)
 {
        char buf[SIZ];
        int a;
 
-       /* Tell the server what kind of client is connecting */
+       /** Tell the server what kind of client is connecting */
        serv_printf("IDEN %d|%d|%d|%s|%s",
                DEVELOPER_ID,
                CLIENT_ID,
@@ -28,12 +32,13 @@ void get_serv_info(char *browser_host, char *user_agent)
        );
        serv_getln(buf, sizeof buf);
 
-       /* Tell the server what kind of richtext we prefer */
+       /** Tell the server what kind of richtext we prefer */
        serv_puts("MSGP text/html|text/plain");
        serv_getln(buf, sizeof buf);
 
 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
-       /* Tell the server that when we save a calendar event, we
+       /**
+        * Tell the server that when we save a calendar event, we
         * want invitations to be generated by the Citadel server
         * instead of by the client.
         */
@@ -41,7 +46,7 @@ void get_serv_info(char *browser_host, char *user_agent)
        serv_getln(buf, sizeof buf);
 #endif
 
-       /* Now ask the server to tell us a little bit about itself... */
+       /** Now ask the server to tell us a little bit about itself... */
        serv_puts("INFO");
        serv_getln(buf, sizeof buf);
        if (buf[0] != '1')
@@ -88,8 +93,9 @@ void get_serv_info(char *browser_host, char *user_agent)
 
 
 
-/* 
- * Read Citadel variformat text and spit it out as HTML.
+/**
+ * \brief Read Citadel variformat text and spit it out as HTML.
+ * \param align html align string
  */
 void fmout(char *align)
 {
@@ -105,7 +111,8 @@ void fmout(char *align)
                }
                intext = 1;
 
-               /* Quoted text should be displayed in italics and in a
+               /**
+                * Quoted text should be displayed in italics and in a
                 * different colour.  This code understands Citadel-style
                 * " >" quotes and will convert to <BLOCKQUOTE> tags.
                 */
@@ -119,7 +126,7 @@ void fmout(char *align)
                if ((bq == 1) && (!strncmp(buf, " >", 2))) {
                        strcpy(buf, &buf[2]);
                }
-               /* Activate embedded URL's */
+               /** Activate embedded URL's */
                url(buf);
 
                escputs(buf);
@@ -134,8 +141,8 @@ void fmout(char *align)
 
 
 
-/* 
- * Read Citadel variformat text and spit it out as HTML in a form
+/**
+ * \brief Read Citadel variformat text and spit it out as HTML in a form
  * suitable for embedding in another message (forward/quote).
  * (NO LINEBREAKS ALLOWED HERE!)
  */
@@ -151,7 +158,8 @@ void pullquote_fmout(void) {
                }
                intext = 1;
 
-               /* Quoted text should be displayed in italics and in a
+               /**
+                * Quoted text should be displayed in italics and in a
                 * different colour.  This code understands Citadel-style
                 * " >" quotes and will convert to <BLOCKQUOTE> tags.
                 */
@@ -176,9 +184,10 @@ void pullquote_fmout(void) {
 
 
 
-/*
- * Transmit message text (in memory) to the server.
- * If convert_to_html is set to 1, the message is converted into something
+/**
+ * \brief Transmit message text (in memory) to the server.
+ * \param ptr the output buffer
+ * \param convert_to_html if set to 1, the message is converted into something
  * which kind of resembles HTML.
  */
 void text_to_server(char *ptr, int convert_to_html)
@@ -228,8 +237,8 @@ void text_to_server(char *ptr, int convert_to_html)
 
 
 
-/*
- * translate server message output to text
+/**
+ * \brief translate server message output to text
  * (used for editing room info files and such)
  */
 void server_to_text()
@@ -249,9 +258,11 @@ void server_to_text()
 
 
 
-/*
+/**
  * Read binary data from server into memory using a series of
  * server READ commands.
+ * \param buffer the output buffer
+ * \param total_len the maximal length of buffer
  */
 void read_server_binary(char *buffer, size_t total_len) {
        char buf[SIZ];
@@ -281,8 +292,8 @@ void read_server_binary(char *buffer, size_t total_len) {
 }
 
 
-/*
- * Read text from server, appending to a string buffer until the
+/**
+ * \brief Read text from server, appending to a string buffer until the
  * usual 000 terminator is found.  Caller is responsible for freeing
  * the returned pointer.
  */
@@ -317,3 +328,7 @@ char *read_server_text(void) {
 
        return(text);
 }
+
+
+
+/*@}*/