From 0b7fda8f24d229e6a6e65b3be192c3d7282dda40 Mon Sep 17 00:00:00 2001 From: Wilfried Goesgens Date: Thu, 28 Jul 2011 12:32:42 +0000 Subject: [PATCH] more documentation work.. --- webcit/tcp_sockets.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/webcit/tcp_sockets.h b/webcit/tcp_sockets.h index 1c8591e03..a8bfb20ca 100644 --- a/webcit/tcp_sockets.h +++ b/webcit/tcp_sockets.h @@ -4,6 +4,11 @@ int serv_getln(char *strbuf, int bufsize); int StrBuf_ServGetln(StrBuf *buf); /** + * @defgroup CoreSrv Core Server Functionality + */ + +/** + * @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. @@ -11,9 +16,12 @@ int StrBuf_ServGetln(StrBuf *buf); * 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); -/* to migrate old calls.... */ +/** + * @ingroup CoreSrv + * @brief to migrate old calls.... + */ #define GetServerStatus(a, b) GetServerStatusMsg(a, b, 0, 0) int serv_puts(const char *string); -- 2.39.2