aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/variadic_args.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/variadic_args.rst
parentda0913771538fd9b1ca538615fd9aa0388608466 (diff)
remove sol2 (will re-add as submodule)
Diffstat (limited to 'lib/sol2/docs/source/api/variadic_args.rst')
-rw-r--r--lib/sol2/docs/source/api/variadic_args.rst25
1 files changed, 0 insertions, 25 deletions
diff --git a/lib/sol2/docs/source/api/variadic_args.rst b/lib/sol2/docs/source/api/variadic_args.rst
deleted file mode 100644
index b7c2d3d..0000000
--- a/lib/sol2/docs/source/api/variadic_args.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-variadic_args
-=============
-*transparent argument to deal with multiple parameters to a function*
-
-
-.. code-block:: cpp
-
- struct variadic_args;
-
-This class is meant to represent every single argument at its current index and beyond in a function list. It does not increment the argument count and is thus transparent. You can place it anywhere in the argument list, and it will represent all of the objects in a function call that come after it, whether they are listed explicitly or not.
-
-``variadic_args`` also has ``begin()`` and ``end()`` functions that return (almost) random-acess iterators. These return a proxy type that can be implicitly converted to a type you want, much like the :doc:`table proxy type<proxy>`.
-
-.. literalinclude:: ../../../examples/source/variadic_args.cpp
- :linenos:
-
-You can also "save" arguments and the like later, by stuffing them into a ``std::vector<sol::object>`` or something similar that serializes them into the registry. Below is an example of saving all of the arguments provided by ``sol::variadic_args`` in a lambda capture variable called ``args``.
-
-.. literalinclude:: ../../../examples/source/variadic_args_storage.cpp
- :linenos:
-
-Finally, note that you can use ``sol::variadic_args`` constructor to "offset"/"shift over" the arguments being viewed:
-
-.. literalinclude:: ../../../examples/source/variadic_args_shifted.cpp
- :linenos: