libt2n: (gerd) some documentation improvement as preparation for release

[libt2n] / src / server.cpp

diff --git a/src/server.cpp b/src/server.cpp
index 65ce62f..30bf7d3 100644 (file)
--- a/src/server.cpp
+++ b/src/server.cpp
@@ -68,6 +68,11 @@ void server_connection::reset_timeout()
     last_action_time=time(NULL);
 }
 
+/** @brief add a callback to one connection
+
+    @param event event the function will be called at
+    @param func functor (see boost::function) that will be called
+*/
 void server_connection::add_callback(callback_event_type event, const boost::function<void ()>& func)
 {
     if (event == new_connection)
@@ -94,10 +99,10 @@ server::~server()
 /** @brief add a callback
 
     @param event event the function will be called at
-    @param func functor (see boost function) that will be called
+    @param func functor (see boost::function) that will be called
 
     @note use boost::bind to bind to member functions like this:
-        s.add_callback(new_connection,bind(&my_class::func_to_call_back, boost::ref(*this), _1));
+        s.add_callback(new_connection,boost::bind(&my_class::func_to_call_back, boost::ref(*this), _1));
 */
 void server::add_callback(callback_event_type event, const boost::function<void (unsigned int)>& func)
 {
@@ -108,10 +113,16 @@ void server::add_callback(callback_event_type event, const boost::function<void
     {
         std::map<unsigned int, server_connection*>::iterator ie=connections.end();
         for(std::map<unsigned int, server_connection*>::iterator i=connections.begin(); i != ie; i++)
-            i->second->add_callback(event,bind(func, i->first));
+            i->second->add_callback(event,boost::bind(func, i->first));
     }
 }
 
+
+/** @brief an event occured, call all server-side callbacks
+
+    @param event event that occured
+    @param conn_id connection-id parameter that will be given to the callback-function
+*/
 void server::do_callbacks(callback_event_type event, unsigned int conn_id)
 {
     std::list<boost::function<void (unsigned int)> >::iterator i,ie=callbacks[event].end();
@@ -119,6 +130,7 @@ void server::do_callbacks(callback_event_type event, unsigned int conn_id)
         (*i)(conn_id);
 }
 
+/// add a new connection to the server
 int server::add_connection(server_connection* newconn)
 {
     unsigned int cid=next_id++;