doc/yield.rst

   1 yield
   2 ----------------
   3
   4 Motivation
   5 ~~~~~~~~~~
   6
   7 Makes a C++ function yield when returning.
   8
   9 Defined in
  10 ~~~~~~~~~~
  11
  12 .. parsed-literal::
  13
  14     #include <luabind/yield_policy.hpp>
  15
  16 Synopsis
  17 ~~~~~~~~
  18
  19 .. parsed-literal::
  20
  21     yield
  22
  23 Example
  24 ~~~~~~~
  25
  26 .. parsed-literal::
  27
  28     void do_thing_that_takes_time()
  29     {
  30         ...
  31     }
  32
  33     ...
  34
  35     module(L)
  36     [
  37         def("do_thing_that_takes_time", &do_thing_that_takes_time, **yield**)
  38     ];
  39