doxify dccp

[paraslash.git] / dccp_send.c

diff --git a/dccp_send.c b/dccp_send.c
index d56286a6874cb5d56dcb4c427fa4dc05bc001d52..74976cf202a27c430be96448011a966865fbf249 100644 (file)
--- a/dccp_send.c
+++ b/dccp_send.c
@@ -16,6 +16,8 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file dccp_send.c paraslash's dccp sender */
+
 /*
  * based on server.c of dccp-cs-0.01.tar.bz2,
  * (C) 2005 Ian McDonald <imcdnzl@gmail.com>
@@ -44,7 +46,8 @@ struct dccp_client {
        struct sockaddr_in addr;
        /** the position of this client in the client list */
        struct list_head node;
-       int header_sent; /* non-zero if audio file header has been sent */
+       /** non-zero if audio file header has been sent */
+       int header_sent;
 };
 
 static void dccp_pre_select(__unused struct audio_format *af, int *max_fileno, fd_set *rfds,
@@ -204,6 +207,14 @@ static char *dccp_help(void)
        return make_message("no help available\n");
 }
 
+/**
+ * the init function of the dccp sender
+ *
+ * \param s pointer to the dccp sender struct
+ *
+ * It initializes all function pointers of \a s and starts
+ * listening on the given port.
+ */
 void dccp_send_init(struct sender *s)
 {
        int ret;