replace @example with @note

[libt2n] / src / client.cpp

diff --git a/src/client.cpp b/src/client.cpp
index 8c40bc1..686ac0f 100644 (file)
--- a/src/client.cpp
+++ b/src/client.cpp
@@ -51,17 +51,17 @@ void client_connection::close()
 /** 
     @param event event the function will be called at
     @param func functor (see boost function) that will be called
+    @note use boost::bind to bind to member functions and parameters like this:
+    @verbatim
+        // in this example 17 is a fixed parameter that is always added to the call
+        c.add_callback(connection_closed,bind(&my_class::func_to_call_back, boost::ref(*this), 17));
+    @endverbatim
 */
 void client_connection::add_callback(callback_event_type event, const boost::function<void ()>& func)
 {
     callbacks[event].push_back(func);
 }
 
-/**
-    @example callback use boost::bind to bind to member functions and parameters like this:
-        int this example 17 is a fixed parameter that is always added to the call
-        c.add_callback(connection_closed,bind(&my_class::func_to_call_back, boost::ref(*this), 17));
-*/
 
 
 void client_connection::do_callbacks(callback_event_type event)