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

Subject: [Boost-commit] svn:boost r82535 - trunk/libs/coroutine/doc
From: oliver.kowalke_at_[hidden]
Date: 2013-01-18 14:23:01

Author: olli
Date: 2013-01-18 14:23:00 EST (Fri, 18 Jan 2013)
New Revision: 82535
URL: http://svn.boost.org/trac/boost/changeset/82535

Log:
coroutine: small change in documentation

Text files modified: 
   trunk/libs/coroutine/doc/coroutine.qbk |    11 +++++++++++                             
   1 files changed, 11 insertions(+), 0 deletions(-)

Modified: trunk/libs/coroutine/doc/coroutine.qbk
==============================================================================
--- trunk/libs/coroutine/doc/coroutine.qbk	(original)
+++ trunk/libs/coroutine/doc/coroutine.qbk	2013-01-18 14:23:00 EST (Fri, 18 Jan 2013)
@@ -36,6 +36,7 @@
 
         typedef boost::coroutines::coroutine< int( std::string const&) > coro_t;
 
+        // void f( boost::coroutine< std::string const&( int) > & ca)
         void f( coro_t::caller_type & ca)
         {
             ...
@@ -64,6 +65,7 @@
 
         typedef boost::coroutines::coroutine< int( std::string const&) > coro_t;
 
+        // void f( boost::coroutine< std::string const&( int) > & ca)
         void f( coro_t::caller_type & ca);
 
         std::string str("abc");
@@ -74,6 +76,7 @@
 
         typedef boost::coroutines::coroutine< int( int, std::string const&) > coro_t;
 
+        // void f( boost::coroutine< boost::tuple< int, std::string const& >( int) > & ca)
         void f( coro_t::caller_type & ca);
 
         std::string str("abc");
@@ -199,6 +202,7 @@
 
         typedef boost::coroutines::coroutine< int( int) >    coro_t;
 
+        // void fn( boost::coroutines::coroutine< int( int) > & ca)
         void fn( coro_t::caller_type & ca)
         {
             // access the integer argument given to coroutine ctor
@@ -251,6 +255,7 @@
 
         typedef boost::coroutines::coroutine< int(int,int) > coro_t;
 
+        // void fn( boost::coroutines::coroutine< boost::tuple< int, int >( int) > & ca)
         void fn( coro_t::caller_type & ca)
         {
             int a, b;
@@ -297,6 +302,7 @@
 
         typedef boost::coroutines::coroutine< X*() >    coro_t;
 
+        // void fn( boost::coroutines::coroutine< void( X*) > & ca)
         void fn( coro_t::caller_t & ca) {
             X local;
             ca( & local);
@@ -322,6 +328,7 @@
         typedef boost::coroutines::coroutine< int() >       coro_t;
         typedef boost::range_iterator< coro_t >::type       iterator_t;
 
+        // void power( boost::coroutines::coroutine< void( int) > & ca, int number, int exponent)
         void power( coro_t::caller_type & ca, int number, int exponent)
         {
             int counter = 0;
@@ -354,6 +361,7 @@
         typedef boost::coroutines::coroutine< int() >       coro_t;
         typedef boost::range_iterator< coro_t >::type       iterator_t;
 
+        // void power( boost::coroutines::coroutine< void( int) > & ca, int number, int exponent)
         void power( coro_t::caller_type & ca, int number, int exponent)
         {
             int counter = 0;
@@ -392,6 +400,7 @@
 
         typedef boost::coroutines::coroutine< int(int,int) > coro_t;
 
+        // void power( boost::coroutines::coroutine< boost::tuple< int, int >( int) > & ca, int number, int exponent)
         void fn( coro_t::caller_type & ca)
         {
             int a, b;
@@ -436,6 +445,7 @@
 
         typedef boost::coroutines::coroutine< void() >    coro_t;
 
+        // void fn( boost::coroutines::coroutine< void() > & ca)
         void fn( coro_t::caller_type & ca)
         {
             ca();
@@ -511,6 +521,7 @@
             { std::cout << "~X()" << std::endl; }
         };
 
+        // void fn( boost::coroutines::coroutine< void() > & ca)
         void fn( coro_t::caller_type & ca)
         {
             X x;