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

weee slight fix and doc update

Browse Source
This commit is contained in:
ThePhD 2016-10-01 18:19:35 -04:00
parent c77f1a26f5
commit 23c2c6dedc
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/api/proxy.rst
View File

@ -97,7 +97,7 @@ Gets the value associated with the keys the proxy was generated and convers it t
:name: regular-get
template <typename T>
T get( ) const;
decltype(auto) get( ) const;
Gets the value associated with the keys and converts it to the type ``T``.
@ -114,7 +114,7 @@ Gets the value associated with the keys and converts it to the type ``T``. If it
---------------------------------
.. code-block:: c++
:caption: function: validity
:caption: function: valid
:name: proxy-valid
bool valid () const;
@ -157,14 +157,14 @@ Sets the value associated with the keys the proxy was generated with to ``value`
stack_proxy
-----------
``sol::stack_proxy`` is what gets returned by :doc:`sol::variadic_args<variadic_args>` and other parts of the framework. It is similar to proxy, but is meant to alias a stack index and not a named function.
``sol::stack_proxy`` is what gets returned by :doc:`sol::variadic_args<variadic_args>` and other parts of the framework. It is similar to proxy, but is meant to alias a stack index and not a named variable.
.. _function-result:
function_result
---------------
``function_result`` is a temporary-only, intermediate-only implicit conversion worker for when :doc:`function<function>` is called. It is *NOT* meant to be stored or captured with ``auto``. It provides fast access to the desired underlying value. It does not implement ``set`` / ``set_function`` / templated ``operator=``, as shown below for :ref:`proxy<proxy>`.
``function_result`` is a temporary-only, intermediate-only implicit conversion worker for when :doc:`function<function>` is called. It is *NOT* meant to be stored or captured with ``auto``. It provides fast access to the desired underlying value. It does not implement ``set`` / ``set_function`` / templated ``operator=``, as is present on :ref:`proxy<proxy>`.
.. _protected-function-result:
@ -172,7 +172,7 @@ function_result
protected_function_result
-------------------------
``protected_function_result`` is a nicer version of ``function_result`` that can be used to detect errors. Its gives safe access to the desired underlying value. It does not implement ``set`` / ``set_function`` / templated ``operator=``, as shown below for :ref:`proxy<proxy>`.
``protected_function_result`` is a nicer version of ``function_result`` that can be used to detect errors. Its gives safe access to the desired underlying value. It does not implement ``set`` / ``set_function`` / templated ``operator=`` as is present on :ref:`proxy<proxy>`.
.. _note 1:

2
sol/protected_function_result.hpp
View File

@ -114,7 +114,7 @@ namespace sol {
}
template<typename T>
T get() const {
decltype(auto) get() const {
return tagged_get(types<meta::unqualified_t<T>>());
}