osx_write.c: Add doxygen description for struct private_osx_write_data

[paraslash.git] / dccp.c

diff --git a/dccp.c b/dccp.c
index 60667a4efe3b004f9bb0b586460f27904c822d60..fa48976e72f44f0cc8b0bdac7d93bcf6368075ec 100644 (file)
--- a/dccp.c
+++ b/dccp.c
@@ -16,10 +16,32 @@
  *     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"
+#include "fd.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 +51,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;