[Boost-commit] svn:boost r46122 - trunk/libs/thread/doc

From: anthony_at_[hidden]
Date: 2008-06-04 12:00:14

Author: anthonyw
Date: 2008-06-04 12:00:13 EDT (Wed, 04 Jun 2008)
New Revision: 46122
URL: http://svn.boost.org/trac/boost/changeset/46122

Log:
Added documentation for swap()
Text files modified: 
   trunk/libs/thread/doc/thread_ref.qbk |    32 ++++++++++++++++++++++++++++++++        
   1 files changed, 32 insertions(+), 0 deletions(-)

Modified: trunk/libs/thread/doc/thread_ref.qbk
==============================================================================
--- trunk/libs/thread/doc/thread_ref.qbk	(original)
+++ trunk/libs/thread/doc/thread_ref.qbk	2008-06-04 12:00:13 EDT (Wed, 04 Jun 2008)
@@ -206,6 +206,8 @@
         static void sleep(const system_time& xt);
     };
 
+    void swap(thread& lhs,thread& rhs);
+
 [section:default_constructor Default Constructor]
 
     thread();
@@ -451,6 +453,36 @@
 
 [endsect]
 
+[section:swap Member function `swap()`]
+
+    void swap(thread& other);
+
+[variablelist
+
+[[Effects:] [Exchanges the threads of execution associated with `*this` and `other`, so `*this` is associated with the thread of
+execution associated with `other` prior to the call, and vice-versa.]]
+
+[[Postconditions:] [`this->get_id()` returns the same value as `other.get_id()` prior to the call. `other.get_id()` returns the same
+value as `this->get_id()` prior to the call.]]
+
+[[Throws:] [Nothing.]]
+
+]
+
+[endsect]
+
+[section:non_member_swap Non-member function `swap()`]
+
+    void swap(thread& lhs,thread& rhs);
+
+[variablelist
+
+[[Effects:] [[link thread.thread_management.thread.swap `lhs.swap(rhs)`].]]
+
+]
+
+[endsect]
+
 
 [section:id Class `boost::thread::id`]