diff options
| author | clyne <clyne@bitgloo.com> | 2022-11-17 07:41:09 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-17 07:41:09 -0500 |
| commit | 6663c25633a27fcc14d0648bd1afea7ea12f497f (patch) | |
| tree | dcc2ec993db3c4b75c3e7e3df35b0494a9ce1f32 /lib/sol2/docs/source/api/yielding.rst | |
| parent | da0913771538fd9b1ca538615fd9aa0388608466 (diff) | |
| parent | 57013add5b7c524086272be7d395f9ec5109bde2 (diff) | |
Lib cleanup
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**.
|