diff options
| author | Clyne Sullivan <clyne@bitgloo.com> | 2022-11-15 07:35:07 -0500 |
|---|---|---|
| committer | Clyne Sullivan <clyne@bitgloo.com> | 2022-11-15 07:35:07 -0500 |
| commit | a056c15dd3781b4f6bb89fdd738b14cafc00cd85 (patch) | |
| tree | 1775a5913c7bc87563b6b4a29c63514cf15b4185 /lib/sol2/docs/source/api/yielding.rst | |
| parent | 1405d648b6264cfda7c46f5b251258335abaee83 (diff) | |
| parent | 57013add5b7c524086272be7d395f9ec5109bde2 (diff) | |
merge branch lib-cleanup into ui
Diffstat (limited to 'lib/sol2/docs/source/api/yielding.rst')
| -rw-r--r-- | lib/sol2/docs/source/api/yielding.rst | 10 |
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**.
|