From: Jens Thiele <jens.thiele@intra2net.com>
Date: Wed, 13 Dec 2006 16:33:12 +0000 (+0000)
Subject: replace @example with @note
X-Git-Tag: v0.2~26
X-Git-Url: http://developer.intra2net.com/git/?p=libt2n;a=commitdiff_plain;h=e1d0794d7ab00e08ee6c0ed9e6d82afcdf415a84

replace @example with @note
---

diff --git a/src/client.cpp b/src/client.cpp
index 8c40bc1..686ac0f 100644
--- 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)
diff --git a/src/server.cpp b/src/server.cpp
index 331bfc3..7b306e1 100644
--- a/src/server.cpp
+++ b/src/server.cpp
@@ -89,7 +89,7 @@ void server_connection::reset_timeout()
     @param event event the function will be called at
     @param func functor (see boost function) that will be called
 
-    @example use boost::bind to bind to member functions and parameters like this:
+    @note use boost::bind to bind to member functions and parameters like this:
         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));
 */
@@ -128,7 +128,7 @@ server::~server()
     @param event event the function will be called at
     @param func functor (see boost function) that will be called
 
-    @example use boost::bind to bind to member functions like this:
+    @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));
 */
 void server::add_callback(callback_event_type event, const boost::function<void (unsigned int)>& func)