(svn r22424) -Document: some more bits

1 files changed, 11 insertions, 0 deletions

diff --git a/src/network/network_admin.h b/src/network/network_admin.h
index e05637ea7..01e00e334 100644
--- a/src/network/network_admin.h
+++ b/src/network/network_admin.h
@@ -21,6 +21,7 @@
 extern AdminIndex _redirect_console_to_admin;
 
 class ServerNetworkAdminSocketHandler;
+/** Pool with all admin connections. */
 typedef Pool<ServerNetworkAdminSocketHandler, AdminIndex, 2, MAX_ADMINS, PT_NADMIN> NetworkAdminSocketPool;
 extern NetworkAdminSocketPool _networkadminsocket_pool;
 
@@ -82,7 +83,17 @@ public:
 	}
 };
 
+/**
+ * Iterate over all the sockets from a given starting point.
+ * @param var The variable to iterate with.
+ * @param start The start of the iteration.
+ */
 #define FOR_ALL_ADMIN_SOCKETS_FROM(var, start) FOR_ALL_ITEMS_FROM(ServerNetworkAdminSocketHandler, adminsocket_index, var, start)
+
+/**
+ * Iterate over all the sockets.
+ * @param var The variable to iterate with.
+ */
 #define FOR_ALL_ADMIN_SOCKETS(var) FOR_ALL_ADMIN_SOCKETS_FROM(var, 0)
 
 void NetworkAdminClientInfo(const NetworkClientSocket *cs, bool new_client = false);