X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=dccp.c;h=147e46307676b60025561e4f81167a3a72b22b90;hp=60667a4efe3b004f9bb0b586460f27904c822d60;hb=39f4ce8ef309f5ee3e800494a726cda1412916be;hpb=f9149914884d8348ae0dca36aa47478da921ac8b

diff --git a/dccp.c b/dccp.c
index 60667a4e..147e4630 100644
--- a/dccp.c
+++ b/dccp.c
@@ -16,10 +16,31 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file dccp.c common functions of the dccp sender/receiver */
+
+/*
+ * based on common.c of dccp-cs-0.01.tar.bz2,
+ * (C) 2005 Ian McDonald <imcdnzl@gmail.com>
+ */
+
 #include "para.h"
 #include "error.h"
 #include "dccp.h"
 
+/** \cond some magic dccp constants */
+#define SOL_DCCP 269
+#define SOCK_DCCP 6
+#define IPPROTO_DCCP 33
+#define DCCP_SOCKOPT_PACKET_SIZE 1
+#define DCCP_SOCKOPT_SERVICE 2
+/** \endcond */
+
+/**
+ * obtain a dccp socket for sending/receiving
+ *
+ * \return the file descriptor of the new socket or \p -E_DCCP_SOCKET
+ * on errors.
+ */
 int dccp_get_socket(void)
 {
 	int s = socket(AF_INET, SOCK_DCCP, IPPROTO_DCCP);
@@ -29,6 +50,13 @@ int dccp_get_socket(void)
 	return s;
 }
 
+/**
+ * prepare a dccp socket
+ *
+ * \param fd the file descriptor of the socket
+ *
+ * \returns positive on success, negative on errors.
+ */
 int dccp_set_socket(int fd)
 {
 	int pkt_size = 256, ret;