libt2n: (gerd) more documentation-polishing
[libt2n] / src / command_server.cpp
index 6146981..91011fd 100644 (file)
@@ -50,6 +50,7 @@ command_server::command_server(server& _s)
     s.add_callback(new_connection,bind(&command_server::send_hello, boost::ref(*this), _1));
 }
 
+/// send a hello message to a new connection
 void command_server::send_hello(unsigned int conn_id)
 {
     server_connection* sc=s.get_connection(conn_id);
@@ -157,6 +158,7 @@ void command_server::handle_packet(const std::string& packet, server_connection*
 /** @brief handle incoming commands
     @param[in,out] usec_timeout wait until new data is found, max timeout usecs.
             -1: wait endless, 0: instant return
+    @param[out] usec_timeout_remaining microseconds from the timeout that were not used
 */
 void command_server::handle(long long usec_timeout, long long* usec_timeout_remaining)
 {