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

From: anthony_at_[hidden]
Date: 2008-07-25 18:21:06

Author: anthonyw
Date: 2008-07-25 18:21:05 EDT (Fri, 25 Jul 2008)
New Revision: 47817
URL: http://svn.boost.org/trac/boost/changeset/47817

Log:
Added a description for the new thread constructors that allow functions with arguments.
Text files modified: 
   trunk/libs/thread/doc/thread_ref.qbk |    25 +++++++++++++++++++++++++               
   1 files changed, 25 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-07-25 18:21:05 EDT (Fri, 25 Jul 2008)
@@ -176,6 +176,9 @@
         template <class F>
         explicit thread(F f);
 
+        template <class F,class A1,class A2,...>
+        thread(F f,A1 a1,A2 a2,...);
+
         template <class F>
         thread(detail::thread_move_t<F> f);
 
@@ -252,6 +255,28 @@
 
 [endsect]
 
+[section:multiple_argument_constructor Thread Constructor with arguments]
+
+    template <class F,class A1,class A2,...>
+    thread(F f,A1 a1,A2 a2,...);
+
+[variablelist
+
+[[Preconditions:] [`F` and each `A`n must by copyable or movable.]]
+
+[[Effects:] [As if [link
+thread.thread_management.thread.callable_constructor
+`thread(boost::bind(f,a1,a2,...))`. Consequently, `f` and each `a`n
+are copied into internal storage for access by the new thread.]]]
+
+[[Postconditions:] [`*this` refers to the newly created thread of execution.]]
+
+[[Throws:] [__thread_resource_error__ if an error occurs.]]
+
+]
+
+[endsect]
+
 [section:destructor Thread Destructor]
 
     ~thread();