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

Subject: [Boost-commit] svn:boost r84770 - trunk/libs/thread/doc
From: vicente.botet_at_[hidden]
Date: 2013-06-14 01:46:11

Author: viboes
Date: 2013-06-14 01:46:11 EDT (Fri, 14 Jun 2013)
New Revision: 84770
URL: http://svn.boost.org/trac/boost/changeset/84770

Log:
Thread: update future ref doc.

Text files modified: 
   trunk/libs/thread/doc/future_ref.qbk |    76 ++++++++++++++++++++++----------------- 
   1 files changed, 43 insertions(+), 33 deletions(-)

Modified: trunk/libs/thread/doc/future_ref.qbk
==============================================================================
--- trunk/libs/thread/doc/future_ref.qbk	Fri Jun 14 01:41:18 2013	(r84769)
+++ trunk/libs/thread/doc/future_ref.qbk	2013-06-14 01:46:11 EDT (Fri, 14 Jun 2013)	(r84770)
@@ -6,6 +6,7 @@
 ]
 
 
+[///////////////////////////////////]
 [section:reference Futures Reference]
 
   //#include <boost/thread/futures.hpp>
@@ -94,9 +95,9 @@
     void wait_for_all(F1& f1,Fs&... fs); // EXTENSION
 
     template<typename Iterator>
-    Iterator wait_for_any(Iterator begin,Iterator end);
+    Iterator wait_for_any(Iterator begin,Iterator end); // EXTENSION
     template<typename F1,typename... Fs>
-    unsigned wait_for_any(F1& f1,Fs&... fs);
+    unsigned wait_for_any(F1& f1,Fs&... fs); // EXTENSION
     
     template <typename T>
     future<typename decay<T>::type> make_future(T&& value);  // DEPRECATED
@@ -114,6 +115,7 @@
     shared_future<typename decay<T>::type> make_shared_future(T&& value);  // DEPRECATED
     shared_future<void> make_shared_future();  // DEPRECATED
     
+[////////////////////////////////////////]
 [section:future_state Enumeration `state`]
 
     namespace future_state
@@ -123,8 +125,7 @@
 
 
 [endsect]
-
-
+[/////////////////////////////////////////////]
 [section:future_errc Enumeration `future_errc`]
 
   enum class future_errc
@@ -139,6 +140,7 @@
  The enum values of future_errc are distinct and not zero. 
  
 [endsect]
+[///////////////////////////////////]
 [section:launch Enumeration `launch`]
 
     enum class launch
@@ -151,6 +153,7 @@
 The enum type launch is a bitmask type with launch::async and launch::deferred denoting individual bits. 
 
 [endsect]
+[///////////////////////////////////////////////////////////////////////////]
 [section:is_error_code_enum Specialization `is_error_code_enum<future_errc>`]
 
   namespace system
@@ -161,6 +164,7 @@
   }
 
 [endsect]
+[///////////////////////////////////////////////////////////////]
 [section:make_error_code Non-member function `make_error_code()`]
 
   namespace system
@@ -175,6 +179,7 @@
 ]  
 
 [endsect]
+[/////////////////////////////////////////////////////////////////////////]
 [section:make_error_condition Non-member function `make_error_condition()`]
 
   namespace system
@@ -189,6 +194,7 @@
 ]  
 
 [endsect]
+[///////////////////////////////////////////////////////////////]
 [section:future_category Non-member function `future_category()`]
 
   const system::error_category& future_category();
@@ -203,6 +209,7 @@
 ]  
 
 [endsect]
+[/////////////////////////////////////////]
 [section:future_error Class `future_error`]
 
   class future_error
@@ -214,6 +221,7 @@
       const system::error_code& code() const no_except;
   };
 
+[///////////////////////////////]
 [section:constructor Constructor]
 
       future_error(system::error_code ec);
@@ -229,6 +237,7 @@
 ]
 
 [endsect]
+[/////////////////////////////////////]
 [section:code Member function `code()`]
 
       const system::error_code& code() const no_except;
@@ -243,7 +252,7 @@
 
 
 [endsect]
-
+[/////////////////////////////////////////////////]
 [section:future_status Enumeration `future_status`]
 
   enum class future_status {
@@ -251,7 +260,7 @@
   };
 
 [endsect]
-
+[////////////////////////////////////////////////////]
 [section:unique_future __unique_future class template]
 
     template <typename R>
@@ -333,6 +342,7 @@
 
 [endsect]
 
+[/////////////////////////////]
 [section:destructor Destructor]
 
     ~__unique_future__();
@@ -937,6 +947,7 @@
             
     };
 
+[///////////////////////////////////////////////]
 [section:default_constructor Default Constructor]
 
     shared_future();
@@ -1327,6 +1338,7 @@
       void set_wait_callback(F f); // EXTENSION
     };
 
+[///////////////////////////////////////////////]
 [section:default_constructor Default Constructor]
 
     promise();
@@ -1613,6 +1625,7 @@
       void set_wait_callback(F f);  // EXTENSION
     };
 
+[/////////////////////////////////////////]
 [section:task_constructor Task Constructor]
 
     packaged_task(R(*f)(ArgTypes...));
@@ -1731,7 +1744,7 @@
 ]
 
 [endsect]
-
+[////////////////////////////////////////////////////]
 [section:call_operator Member Function `operator()()`]
 
     void operator()();
@@ -1753,7 +1766,7 @@
 ]
 
 [endsect]
-
+[///////////////////////////////////////////////////////////////////////////////]
 [section:make_ready_at_thread_exit Member Function `make_ready_at_thread_exit()`]
 
       void make_ready_at_thread_exit(ArgTypes...);
@@ -1776,8 +1789,7 @@
 ]
 
 [endsect]
-
-
+[///////////////////////////////////////]
 [section:reset Member Function `reset()`]
 
       void reset();
@@ -1792,7 +1804,7 @@
 ]
 
 [endsect]
-
+[/////////////////////////////////////////////////////////////////////////]
 [section:set_wait_callback Member Function `set_wait_callback()` EXTENSION]
 
     template<typename F>
@@ -1816,8 +1828,7 @@
 
 
 [endsect]
-
-
+[//////////////////////////////////////////////////////]
 [section:decay_copy  Non-member function `decay_copy()`]
   template <class T>
   typename decay<T>::type decay_copy(T&& v)
@@ -1826,7 +1837,7 @@
   }
 
 [endsect]
-
+[///////////////////////////////////////////]
 [section:async Non-member function `async()`]
 
    
@@ -1984,24 +1995,23 @@
 
 
 [endsect]
-
-
-[section:wait_for_any Non-member function `wait_for_any()`]
+[/////////////////////////////////////////////////////////////////////]
+[section:wait_for_any Non-member function `wait_for_any()` - EXTENSION]
 
     template<typename Iterator>
-    Iterator wait_for_any(Iterator begin,Iterator end);
+    Iterator wait_for_any(Iterator begin,Iterator end); // EXTENSION
 
     template<typename F1,typename F2>
-    unsigned wait_for_any(F1& f1,F2& f2);
+    unsigned wait_for_any(F1& f1,F2& f2); // EXTENSION
 
     template<typename F1,typename F2,typename F3>
-    unsigned wait_for_any(F1& f1,F2& f2,F3& f3);
+    unsigned wait_for_any(F1& f1,F2& f2,F3& f3); // EXTENSION
 
     template<typename F1,typename F2,typename F3,typename F4>
-    unsigned wait_for_any(F1& f1,F2& f2,F3& f3,F4& f4);
+    unsigned wait_for_any(F1& f1,F2& f2,F3& f3,F4& f4); // EXTENSION
 
     template<typename F1,typename F2,typename F3,typename F4,typename F5>
-    unsigned wait_for_any(F1& f1,F2& f2,F3& f3,F4& f4,F5& f5);
+    unsigned wait_for_any(F1& f1,F2& f2,F3& f3,F4& f4,F5& f5); // EXTENSION
 
 [variablelist
 
@@ -2025,23 +2035,23 @@
 
 
 [endsect]
-
-[section:wait_for_all Non-member function `wait_for_all()`]
+[/////////////////////////////////////////////////////////////////////]
+[section:wait_for_all Non-member function `wait_for_all()` - EXTENSION]
 
     template<typename Iterator>
-    void wait_for_all(Iterator begin,Iterator end);
+    void wait_for_all(Iterator begin,Iterator end); // EXTENSION
 
     template<typename F1,typename F2>
-    void wait_for_all(F1& f1,F2& f2);
+    void wait_for_all(F1& f1,F2& f2); // EXTENSION
 
     template<typename F1,typename F2,typename F3>
-    void wait_for_all(F1& f1,F2& f2,F3& f3);
+    void wait_for_all(F1& f1,F2& f2,F3& f3); // EXTENSION
 
     template<typename F1,typename F2,typename F3,typename F4>
-    void wait_for_all(F1& f1,F2& f2,F3& f3,F4& f4);
+    void wait_for_all(F1& f1,F2& f2,F3& f3,F4& f4); // EXTENSION
 
     template<typename F1,typename F2,typename F3,typename F4,typename F5>
-    void wait_for_all(F1& f1,F2& f2,F3& f3,F4& f4,F5& f5);
+    void wait_for_all(F1& f1,F2& f2,F3& f3,F4& f4,F5& f5); // EXTENSION
 
 [variablelist
 
@@ -2060,7 +2070,7 @@
 
 
 [endsect]
-
+[/////////////////////////////////////////////////////////////////////////////]
 [section:make_ready_future Non-member function `make_ready_future()` EXTENSION]
 
     template <typename T>
@@ -2104,7 +2114,7 @@
 ]
     
 [endsect]
-
+[//////////////////////////////////////////////////////////////////]
 [section:make_future Non-member function `make_future()` DEPRECATED]
 
     template <typename T>
@@ -2138,9 +2148,9 @@
 [[See:] [`make_ready_future()`]]
 
 ]
-
-    
+   
 [endsect]
+[////////////////////////////////////////////////////////////////////////////////]
 [section:make_shared_future Non-member function `make_shared_future()` DEPRECATED]
 
     template <typename T>