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

Fixed links in docs/api/reference

Browse Source
This commit is contained in:
jkbz64 2016-09-07 12:51:10 +02:00
parent cef0bd56b5
commit b65c58748a
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/api/reference.rst
View File

@ -8,7 +8,7 @@ general purpose reference to Lua object in registry
class reference;
This type keeps around a reference to something that was on the stack and places it in the Lua registry. It is the backbone for all things that reference items on the stack and needs to keep them around beyond their appearance and lifetime on said Lua stack. Its progeny include :doc:`sol::coroutine<coroutine>`, :doc:`sol::function<function>`, :doc:`sol::<protected_function>`, :doc:`sol::object<object>`, :doc:`sol::table<table>`/:doc:`sol::global_table<table>`, :doc:`sol::<thread>`, and :doc:`sol::userdata<userdata>`.
This type keeps around a reference to something that was on the stack and places it in the Lua registry. It is the backbone for all things that reference items on the stack and needs to keep them around beyond their appearance and lifetime on said Lua stack. Its progeny include :doc:`sol::coroutine<coroutine>`, :doc:`sol::function<function>`, :doc:`sol::protected_function<protected_function>`, :doc:`sol::object<object>`, :doc:`sol::table<table>`/:doc:`sol::global_table<table>`, :doc:`sol::thread<thread>`, and :doc:`sol::userdata<userdata>`.
For all of these types, there's also a ``stack_{x}`` version of them, such as ``stack_table``
@ -72,4 +72,4 @@ non-members
Compares two references using the Lua API's `lua_compare`_ for equality.
.. _lua_compare: https://www.lua.org/manual/5.3/manual.html#lua_compare
.. _lua_compare: https://www.lua.org/manual/5.3/manual.html#lua_compare