StarMirror/sol2
1
0
Fork 0
mirror of https://github.com/ThePhD/sol2.git synced 2024-03-22 13:10:44 +08:00
Code Issues Projects Releases Wiki Activity

[ci-skip] doc polish

Browse Source
This commit is contained in:
ThePhD 2017-07-01 11:20:39 -04:00
parent aea873a485
commit 345a398cdc
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/api/state.rst
View File

@ -176,7 +176,7 @@ Attempts to run the garbage collector. Note that this is subject to the same rul
template <typename Key, typename Value, typename... Args>
static sol::table create_table(lua_State* L, int narr, int nrec, Key&& key, Value&& value, Args&&... args);
Creates a table. Forwards its arguments to :ref:`table::create<table-create>`.
Creates a table. Forwards its arguments to :ref:`table::create<table-create>`. Applies the same rules as :ref:`table.set<set-value>` when putting the argument values into the table, including how it handles callable objects.
.. _standard lua libraries: http://www.lua.org/manual/5.3/manual.html#6
.. _luaL_requiref: https://www.lua.org/manual/5.3/manual.html#luaL_requiref

8
docs/source/api/table.rst
View File

@ -63,7 +63,7 @@ These functions set items into the table. The first one (``set``) can set *mult
.. note::
Value semantics are applied to all set operations. If you do not ``std::ref( obj )`` or specifically make a pointer with ``std::addressof( obj )`` or ``&obj``, it will copy / move. This is different from how :doc:`sol::function<function>` behaves with its call operator.
Value semantics are applied to all set operations. If you do not ``std::ref( obj )`` or specifically make a pointer with ``std::addressof( obj )`` or ``&obj``, it will copy / move. This is different from how :doc:`sol::function<function>` behaves with its call operator. Also note that this does not detect callables by default: see the :ref:`note here<binding-callable-objects>`.
.. code-block:: cpp
:caption: function: set a function with the specified key into lua
@ -72,7 +72,7 @@ These functions set items into the table. The first one (``set``) can set *mult
template<typename Key, typename Fx>
state_view& set_function(Key&& key, Fx&& fx, [...]);
Sets the desired function to the specified key value. Note that it also allows for passing a member function plus a member object or just a single member function: however, using a lambda is almost always better when you want to bind a member function + class instance to a single function call in Lua.
Sets the desired function to the specified key value. Note that it also allows for passing a member function plus a member object or just a single member function: however, using a lambda is almost always better when you want to bind a member function + class instance to a single function call in Lua. Also note that this will allow Lua to understand that a callable object (such as a lambda) should be serialized as a function and not as a userdata: see the :ref:`note here<binding-callable-objects>` for more details.
.. code-block:: cpp
:caption: function: add
@ -202,7 +202,7 @@ Creates a table, optionally with the specified values pre-set into the table. If
static table create_with(lua_State* L, Args&&... args);
Creates a table, optionally with the specified values pre-set into the table. It checks every 2nd argument (the keys) and generates hints for how many array or map-style entries will be placed into the table.
Creates a table, optionally with the specified values pre-set into the table. It checks every 2nd argument (the keys) and generates hints for how many array or map-style entries will be placed into the table. Applies the same rules as :ref:`table.set<set-value>` when putting the argument values into the table, including how it handles callable objects.
.. code-block:: cpp
:caption: function: create a named table with compile-time defaults assumed
@ -212,6 +212,6 @@ Creates a table, optionally with the specified values pre-set into the table. It
table create_named(Name&& name, Args&&... args);
Creates a table, optionally with the specified values pre-set into the table, and sets it as the key ``name`` in the table.
Creates a table, optionally with the specified values pre-set into the table, and sets it as the key ``name`` in the table. Applies the same rules as :ref:`table.set<set-value>` when putting the argument values into the table, including how it handles callable objects.
.. _input iterators: http://en.cppreference.com/w/cpp/concept/InputIterator