Add file-level doxygen comment blocks where they were missing.

[ircu2.10.12-pk.git] / include / s_bsd.h

diff --git a/include/s_bsd.h b/include/s_bsd.h
index fbef2bf38f7712b67fb7b02c78015127c1ef6c9e..c4c1387e742d35b7ea10719e897d70d81903aef4 100644 (file)
--- a/include/s_bsd.h
+++ b/include/s_bsd.h
@@ -1,7 +1,6 @@
-/*
- * s_bsd.h
- *
- * $Id$
+/** @file s_bsd.h
+ * @brief Wrapper functions to avoid direct use of BSD APIs.
+ * @version $Id$
  */
 #ifndef INCLUDED_s_bsd_h
 #define INCLUDED_s_bsd_h
@@ -26,7 +25,9 @@ struct irc_in_addr;
  * set client to a smaller size to allow TCP flow control
  * to reduce flooding
  */
+/** Default TCP window size for server connections. */
 #define SERVER_TCP_WINDOW 61440
+/** Default TCP window size for client connections. */
 #define CLIENT_TCP_WINDOW 2048
 
 extern void report_error(const char* text, const char* who, int err);