Adjusted paramhandling to accept parameters with empty values (which is legal)

[citadel.git] / webcit / tcp_sockets.h

diff --git a/webcit/tcp_sockets.h b/webcit/tcp_sockets.h
index a8bfb20ca3e266fa4d42e5b2d16c3590a1f18486..8528539bf9ef04d32036f20716b9049b736862a9 100644 (file)
--- a/webcit/tcp_sockets.h
+++ b/webcit/tcp_sockets.h
@@ -1,26 +1,36 @@
+/*
+ * Copyright (c) 1996-2013 by the citadel.org team
+ *
+ * This program is open source software.  You can redistribute it and/or
+ * modify it under the terms of the GNU General Public License, version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
 int uds_connectsock(char *);
 int tcp_connectsock(char *, char *);
 int serv_getln(char *strbuf, int bufsize);
 int StrBuf_ServGetln(StrBuf *buf);
 
-/**
- * @defgroup CoreSrv Core Server Functionality
+/*
+ * parse & check the server reply 
+ *
+ * Line                the line containing the server reply
+ * FullState   if you need more than just the major number, this is returns it. Ignored if NULL.
+ * PutImportantMessage if you want to forward the text part of the server reply to the user, specify 1; 
+ *             the result will be put into the 'Important Message' framework.
+ * MajorOK     in case of which major number not to put the ImportantMessage? 0 for all.
+ *
+ * returns the most significant digit of the server status
  */
 
-/**
- * @ingroup CoreSrv
- * @brief parse & check the server reply 
- * @param Line the line containing the server reply
- * @param FullState if you need more than just the major number, this is returns it. Ignored if NULL.
- * @param PutImportantMessage if you want to forward the text part of the server reply to the user, specify 1; 
- *    the result will be put into the 'Important Message' framework.
- * @param MajorOK in case of which major number not to put the ImportantMessage? 0 for all.
- * @return the most significant digit of the server status
- */
 int GetServerStatusMsg(StrBuf *Line, long* FullState, int PutImportantMessage, int MajorOK);
-/**
- * @ingroup CoreSrv
- * @brief to migrate old calls.... 
+
+/*
+ * to migrate old calls.... 
  */
 #define GetServerStatus(a, b) GetServerStatusMsg(a, b, 0, 0)