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

Subject: [Boost-commit] svn:boost r62079 - trunk/libs/thread/doc
From: anthony_at_[hidden]
Date: 2010-05-18 04:25:04

Author: anthonyw
Date: 2010-05-18 04:25:02 EDT (Tue, 18 May 2010)
New Revision: 62079
URL: http://svn.boost.org/trac/boost/changeset/62079

Log:
Added documentation for boost::move on thread objects

Text files modified: 
   trunk/libs/thread/doc/thread_ref.qbk |    21 +++++++++++++++++++++                   
   1 files changed, 21 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	2010-05-18 04:25:02 EDT (Tue, 18 May 2010)
@@ -219,6 +219,7 @@
     };
 
     void swap(thread& lhs,thread& rhs);
+    detail::thread_move_t<thread> move(detail::thread_move_t<thread> t);
 
 [section:default_constructor Default Constructor]
 
@@ -521,6 +522,26 @@
 
 [endsect]
 
+[section:non_member_move Non-member function `move()`]
+
+    #include <boost/thread/thread.hpp>
+
+    detail::thread_move_t<thread> move(detail::thread_move_t<thread> t)
+
+[variablelist
+
+[[Returns:] [`t`.]]
+
+]
+
+Enables moving thread objects. e.g.
+
+    extern void some_func();
+    boost::thread t(some_func);
+    boost::thread t2(boost::move(t)); // transfer thread from t to t2
+
+[endsect]
+
 
 [section:id Class `boost::thread::id`]