aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/yielding.rst
diff options
context:
space:
mode:
authorClyne Sullivan <clyne@bitgloo.com>2022-08-19 19:48:10 -0400
committerClyne Sullivan <clyne@bitgloo.com>2022-08-19 19:48:10 -0400
commitc467671ae8b6ec161c17e86f3383fd0625f755b8 (patch)
treefd126d5721256b15c0d71e4c47033e341bdb7816 /lib/sol2/docs/source/api/yielding.rst
parentda0913771538fd9b1ca538615fd9aa0388608466 (diff)
remove sol2 (will re-add as submodule)
Diffstat (limited to 'lib/sol2/docs/source/api/yielding.rst')
-rw-r--r--lib/sol2/docs/source/api/yielding.rst10
1 files changed, 0 insertions, 10 deletions
diff --git a/lib/sol2/docs/source/api/yielding.rst b/lib/sol2/docs/source/api/yielding.rst
deleted file mode 100644
index ad124b1..0000000
--- a/lib/sol2/docs/source/api/yielding.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-yielding
-========
-*telling a C++ function to yield its results into Lua*
-
-.. code-block:: cpp
-
- template <typename F>
- yield_wrapper<F> yielding( F&& f )
-
-``sol::yielding`` is useful for calling C++ functions which need to yield into a Lua coroutine. It is a wrapper around a single argument which is expected to be bound as a function. You can pass it anywhere a regular function can be bound, **except for in usertype definitions**.