libt2n: (gerd) doxygenize

[libt2n] / src / server.cpp

diff --git a/src/server.cpp b/src/server.cpp
index 3972ef4..20cce1e 100644 (file)
--- a/src/server.cpp
+++ b/src/server.cpp
@@ -52,11 +52,11 @@ int server::add_connection(server_connection* newconn)
 }
 
 /**
-    Gets a connection by id
+    @brief Gets a connection by id
     
-    \param conn_id Connection ID
+    @param conn_id Connection ID
     
-    \retval Pointer to connection object
+    @retval Pointer to connection object
 */
 server_connection* server::get_connection(unsigned int conn_id)
 {
@@ -67,6 +67,7 @@ server_connection* server::get_connection(unsigned int conn_id)
         return p->second;
 }
 
+/// check for timeouts, remove closed connections. don't forget to call this from time to time.
 void server::cleanup()
 {
     std::map<unsigned int, server_connection*>::iterator ie=connections.end();