[Boost-commit] svn:boost r85857 - trunk/libs/coroutine/doc

Subject: [Boost-commit] svn:boost r85857 - trunk/libs/coroutine/doc
From: oliver.kowalke_at_[hidden]
Date: 2013-09-23 13:19:37

Author: olli
Date: 2013-09-23 13:19:37 EDT (Mon, 23 Sep 2013)
New Revision: 85857
URL: http://svn.boost.org/trac/boost/changeset/85857

Log:
coroutine: fixing typos in documentation

Text files modified: 
   trunk/libs/coroutine/doc/coro.qbk      |     3 ++-                                     
   trunk/libs/coroutine/doc/unidirect.qbk |    38 +++++++++++++++++++-------------------  
   2 files changed, 21 insertions(+), 20 deletions(-)

Modified: trunk/libs/coroutine/doc/coro.qbk
==============================================================================
--- trunk/libs/coroutine/doc/coro.qbk	Mon Sep 23 13:03:41 2013	(r85856)
+++ trunk/libs/coroutine/doc/coro.qbk	2013-09-23 13:19:37 EDT (Mon, 23 Sep 2013)	(r85857)
@@ -5,7 +5,7 @@
           http://www.boost.org/LICENSE_1_0.txt
 ]
 
-[article Coroutine
+[library Coroutine
     [quickbook 1.5]
     [authors [Kowalke, Oliver]]
     [copyright 2009 Oliver Kowalke]
@@ -69,6 +69,7 @@
 [def __getline__ ['std::getline()]]
 [def __handle_read__ ['session::handle_read()]]
 [def __io_service__ ['boost::asio::io_sevice]]
+[def __pull_coro_bool__ ['boost::coroutines::coroutine<>::pull_type::operator bool]]
 [def __pull_coro_get__ ['boost::coroutines::coroutine<>::pull_type::get()]]
 [def __pull_coro_it__ ['boost::coroutines::coroutine<>::pull_type::iterator]]
 [def __pull_coro_op__ ['boost::coroutines::coroutine<>::pull_type::operator()]]

Modified: trunk/libs/coroutine/doc/unidirect.qbk
==============================================================================
--- trunk/libs/coroutine/doc/unidirect.qbk	Mon Sep 23 13:03:41 2013	(r85856)
+++ trunk/libs/coroutine/doc/unidirect.qbk	2013-09-23 13:19:37 EDT (Mon, 23 Sep 2013)	(r85857)
@@ -57,7 +57,7 @@
 managed by the instance of __pull_coro__.
 A __push_coro__ is automatically generated by the runtime and passed as
 reference to the lambda function. Each time the lambda function calls
-__push_coro__op with another Fibonacci number, __push_coro__ transfers it back
+__push_coro_op__ with another Fibonacci number, __push_coro__ transfers it back
 to the main execution context. The local state of __coro_fn__ is preserved and
 will be restored upon transferring execution control back to __coro_fn__
 to calculate the next Fibonacci number.
@@ -73,7 +73,7 @@
 The constructor of __push_coro__ takes a function (__coro_fn__) accepting a
 reference to a __pull_coro__ as argument. In contrast to __pull_coro__,
 instantiating a __push_coro__ does not pass the control of execution to
-__coro_fn__ - instead the first call of __push_coro__op synthesizes a
+__coro_fn__ - instead the first call of __push_coro_op__ synthesizes a
 complementary __pull_coro__ and passes it as reference to __coro_fn__.
 
 The interface does not contain a ['get()]-function: you can not retrieve
@@ -133,10 +133,10 @@
 The __coro_fn__ is executed in a newly created execution context which is
 managed by the instance of __push_coro__.
 The main execution context passes the strings to the __coro_fn__ by calling
-__push_coro__op.
+__push_coro_op__.
 A __pull_coro__ is automatically generated by the runtime and passed as
 reference to the lambda function. The __coro_fn__ accesses the strings passed
-from the main execution context by calling __pull_coro__get and lays those
+from the main execution context by calling __pull_coro_get__ and lays those
 strings out on ['std::cout] according the parameters 'num' and 'width'.
 The local state of __coro_fn__ is preserved and will be restored after
 transferring execution control back to __coro_fn__.
@@ -205,7 +205,7 @@
 On POSIX systems, the coroutine context switch does not preserve signal masks
 for performance reasons.
 
-A context switch is done via __push_coro__op and __pull_coro__op.
+A context switch is done via __push_coro_op__ and __pull_coro_op__.
 
 [warning Calling __push_coro_op__/__pull_coro_op__ from inside the [_same]
 coroutine results in undefined behaviour.]
@@ -218,10 +218,10 @@
 Both coroutine types take the same template argument.
 For __pull_coro__ the __coro_fn__ is entered at __pull_coro__ construction.
 For __push_coro__ the __coro_fn__ is not entered at __push_coro__ construction
-but entered by the first invocation of __push_coro__op.
+but entered by the first invocation of __push_coro_op__.
 After execution control is returned from __coro_fn__ the state of the
 coroutine can be checked via
-__pull_coro__bool returning true if the coroutine is still valid (__coro_fn__
+__pull_coro_bool__ returning true if the coroutine is still valid (__coro_fn__
 has not terminated). Unless T is void, true also implies that a data value is
 available.
 
@@ -230,12 +230,12 @@
 In order to transfer data from a __pull_coro__ to the main-context the framework
 synthesizes a __push_coro__ associated with the __pull_coro__ instance in the
 main-context. The synthesized __push_coro__ is passed as argument to __coro_fn__.\\
-The __coro_fn__ must call this __push_coro__op in order to transfer each
+The __coro_fn__ must call this __push_coro_op__ in order to transfer each
 data value back to the main-context.
-In the main-context, the __pull_coro__bool determines whether the coroutine is
+In the main-context, the __pull_coro_bool__ determines whether the coroutine is
 still valid and a data value is available or __coro_fn__ has terminated
 (__pull_coro__ is invalid; no data value available). Access to the transferred
-data value is given by __pull_coro__get.
+data value is given by __pull_coro_get__.
 
         std::coroutine<int>::pull_type source( // constructor enters coroutine-function
             [&](std::coroutine<int>::push_type& sink){
@@ -257,9 +257,9 @@
 In order to transfer data to a __push_coro__ from the main-context the framework
 synthesizes a __pull_coro__ associated with the __push_coro__ instance in the
 main-context. The synthesized __pull_coro__ is passed as argument to __coro_fn__.
-The main-context must call this __push_coro__op in order to transfer each data
+The main-context must call this __push_coro_op__ in order to transfer each data
 value into the __coro_fn__.
-Access to the transferred data value is given by __pull_coro__get.
+Access to the transferred data value is given by __pull_coro_get__.
 
         std::coroutine<int>::push_type sink( // constructor does NOT enter coroutine-function
             [&](std::coroutine<int>::pull_type& source){
@@ -276,10 +276,10 @@
 
 [heading accessing parameters]
 Parameters returned from or transferred to the __coro_fn__ can be accessed with
-__pull_coro__get.
+__pull_coro_get__.
 
 Splitting-up the access of parameters from context switch function enables to
-check if __pull_coro__ is valid after return from __pull_coro__op, e.g.
+check if __pull_coro__ is valid after return from __pull_coro_op__, e.g.
 __pull_coro__ has values and __coro_fn__ has not terminated.
 
         std::coroutine<std::tuple<int,int>>::push_type sink(
@@ -294,13 +294,13 @@
 
 [heading exceptions]
 An exception thrown inside a __pull_coro__'s __coro_fn__ before its first call
-to __push_coro__op will be re-thrown by the __pull_coro__ constructor. After a
-__pull_coro__'s __coro_fn__'s first call to __push_coro__op, any subsequent
-exception inside that __coro_fn__ will be re-thrown by __pull_coro__op.
-__pull_coro__get does not throw.
+to __push_coro_op__ will be re-thrown by the __pull_coro__ constructor. After a
+__pull_coro__'s __coro_fn__'s first call to __push_coro_op__, any subsequent
+exception inside that __coro_fn__ will be re-thrown by __pull_coro_op__.
+__pull_coro_get__ does not throw.
 
 An exception thrown inside a __push_coro__'s __coro_fn__ will be re-thrown by
-__push_coro__op.
+__push_coro_op__.
 
 [important Code executed by coroutine must not prevent the propagation of the
 __forced_unwind__ exception.  Absorbing that exception will cause stack