Skip to content

Commit

Permalink
weee slight fix and doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
ThePhD committed Oct 1, 2016
1 parent c77f1a2 commit 23c2c6d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions docs/source/api/proxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``.

Expand All @@ -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;
Expand Down Expand Up @@ -157,22 +157,22 @@ 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:

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:
Expand Down
2 changes: 1 addition & 1 deletion sol/protected_function_result.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ namespace sol {
}

template<typename T>
T get() const {
decltype(auto) get() const {
return tagged_get(types<meta::unqualified_t<T>>());
}

Expand Down

0 comments on commit 23c2c6d

Please sign in to comment.