[Boost-commit] svn:boost r84879 - trunk/libs/asio/doc

Subject: [Boost-commit] svn:boost r84879 - trunk/libs/asio/doc
From: chris_at_[hidden]
Date: 2013-06-22 08:58:50

Author: chris_kohlhoff
Date: 2013-06-22 08:58:50 EDT (Sat, 22 Jun 2013)
New Revision: 84879
URL: http://svn.boost.org/trac/boost/changeset/84879

Log:
Regenerate documentation.

Text files modified: 
   trunk/libs/asio/doc/reference.qbk |   116 ++++++++++++++++++++++++++++++++++++++- 
   1 files changed, 112 insertions(+), 4 deletions(-)

Modified: trunk/libs/asio/doc/reference.qbk
==============================================================================
--- trunk/libs/asio/doc/reference.qbk	Sat Jun 22 08:57:51 2013	(r84878)
+++ trunk/libs/asio/doc/reference.qbk	2013-06-22 08:58:50 EDT (Sat, 22 Jun 2013)	(r84879)
@@ -45112,6 +45112,26 @@
   class basic_yield_context
 
 
+[heading Types]
+[table
+  [[Name][Description]]
+
+  [
+
+    [[link boost_asio.reference.basic_yield_context.callee_type [*callee_type]]]
+    [The coroutine callee type, used by the implementation. ]
+  
+  ]
+
+  [
+
+    [[link boost_asio.reference.basic_yield_context.caller_type [*caller_type]]]
+    [The coroutine caller type, used by the implementation. ]
+  
+  ]
+
+]
+
 [heading Member Functions]
 [table
   [[Name][Description]]
@@ -45159,8 +45179,8 @@
 
 
   basic_yield_context(
-      const detail::weak_ptr< boost::coroutines::coroutine< void()> > & coro,
-      boost::coroutines::coroutine< void()>::caller_type & ca,
+      const detail::weak_ptr< callee_type > & coro,
+      caller_type & ca,
       Handler & handler);
 
 
@@ -45171,6 +45191,72 @@
 
 
 
+[section:callee_type basic_yield_context::callee_type]
+
+[indexterm2 callee_type..basic_yield_context] 
+The coroutine callee type, used by the implementation. 
+
+
+  typedef implementation_defined callee_type;
+
+
+
+When using Boost.Coroutine v1, this type is: 
+
+   typename coroutine<void()> 
+
+
+When using Boost.Coroutine v2 (unidirectional coroutines), this type is: 
+
+   push_coroutine<void> 
+
+
+
+
+[heading Requirements]
+
+['Header: ][^boost/asio/spawn.hpp]
+
+['Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
+[section:caller_type basic_yield_context::caller_type]
+
+[indexterm2 caller_type..basic_yield_context] 
+The coroutine caller type, used by the implementation. 
+
+
+  typedef implementation_defined caller_type;
+
+
+
+When using Boost.Coroutine v1, this type is: 
+
+   typename coroutine<void()>::caller_type 
+
+
+When using Boost.Coroutine v2 (unidirectional coroutines), this type is: 
+
+   pull_coroutine<void> 
+
+
+
+
+[heading Requirements]
+
+['Header: ][^boost/asio/spawn.hpp]
+
+['Convenience header: ][^boost/asio.hpp]
+
+
+[endsect]
+
+
+
 [section:operator_lb__rb_ basic_yield_context::operator\[\]]
 
 [indexterm2 operator\[\]..basic_yield_context] 
@@ -45178,7 +45264,7 @@
 
 
   basic_yield_context operator[](
-      boost::system::error_code & ec);
+      boost::system::error_code & ec) const;
 
 
 By default, when a yield context is used with an asynchronous operation, a non-success error\_code is converted to system\_error and thrown. This operator may be used to specify an error\_code object that should instead be set with the asynchronous operation's result. For example:
@@ -95580,7 +95666,7 @@
   [
 
     [[link boost_asio.reference.use_future_t.allocator_type [*allocator_type]]]
-    []
+    [The allocator type. The allocator is used when constructing the std::promise object for a given asynchronous operation. ]
   
   ]
 
@@ -95631,6 +95717,8 @@
 [section:allocator_type use_future_t::allocator_type]
 
 [indexterm2 allocator_type..use_future_t] 
+The allocator type. The allocator is used when constructing the `std::promise` object for a given asynchronous operation. 
+
 
   typedef Allocator allocator_type;
 
@@ -105140,6 +105228,26 @@
   typedef basic_yield_context< unspecified > yield_context;
 
 
+[heading Types]
+[table
+  [[Name][Description]]
+
+  [
+
+    [[link boost_asio.reference.basic_yield_context.callee_type [*callee_type]]]
+    [The coroutine callee type, used by the implementation. ]
+  
+  ]
+
+  [
+
+    [[link boost_asio.reference.basic_yield_context.caller_type [*caller_type]]]
+    [The coroutine caller type, used by the implementation. ]
+  
+  ]
+
+]
+
 [heading Member Functions]
 [table
   [[Name][Description]]