mirror of
https://github.com/ThePhD/sol2.git
synced 2024-03-22 13:10:44 +08:00
fix all doc links
This commit is contained in:
parent
ce1396e7db
commit
dd95030b9e
@ -17,7 +17,7 @@ Whatever the case is, you need it to be returned to Lua and have many of the tra
|
|||||||
|
|
||||||
See `this container example`_ to see how it works.
|
See `this container example`_ to see how it works.
|
||||||
|
|
||||||
.. _this container example: https://github.com/ThePhD/sol2/blob/develop/examples/container_usertype_as_container.cpp
|
.. _this container example: https://github.com/ThePhD/sol2/blob/develop/examples/source/container_usertype_as_container.cpp
|
||||||
.. _Container requirements: http://en.cppreference.com/w/cpp/concept/Container
|
.. _Container requirements: http://en.cppreference.com/w/cpp/concept/Container
|
||||||
.. _Sequence Container requirements: http://en.cppreference.com/w/cpp/concept/SequenceContainer
|
.. _Sequence Container requirements: http://en.cppreference.com/w/cpp/concept/SequenceContainer
|
||||||
.. _forward_list: http://en.cppreference.com/w/cpp/container/forward_list
|
.. _forward_list: http://en.cppreference.com/w/cpp/container/forward_list
|
||||||
|
@ -75,5 +75,5 @@ The second and third unique constructors take a special empty type that serves a
|
|||||||
|
|
||||||
This function applies the environment to the desired target. Not that lua 5.1 only tolerates the application of environments to userdata, threads and functions, while 5.2+ has different (more relaxed) rules. It is called by the free function ``sol::set_environment( env, target );``.
|
This function applies the environment to the desired target. Not that lua 5.1 only tolerates the application of environments to userdata, threads and functions, while 5.2+ has different (more relaxed) rules. It is called by the free function ``sol::set_environment( env, target );``.
|
||||||
|
|
||||||
.. _script calls: https://github.com/ThePhD/sol2/blob/develop/examples/environments.cpp
|
.. _script calls: https://github.com/ThePhD/sol2/blob/develop/examples/source/environments.cpp
|
||||||
.. _set on functions: https://github.com/ThePhD/sol2/blob/develop/examples/environments_on_functions.cpp
|
.. _set on functions: https://github.com/ThePhD/sol2/blob/develop/examples/source/environments_on_functions.cpp
|
||||||
|
@ -65,4 +65,4 @@ These allow a person to compare an ``sol::object`` against :ref:`nil<nil>`, whic
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
.. _any_return example: https://github.com/ThePhD/sol2/blob/develop/examples/any_return.cpp
|
.. _any_return example: https://github.com/ThePhD/sol2/blob/develop/examples/source/any_return.cpp
|
||||||
|
@ -6,4 +6,4 @@ This is an implemention of `optional from the standard library`_. If it detects
|
|||||||
See `this example here`_ for a demonstration on how to use it and other features!
|
See `this example here`_ for a demonstration on how to use it and other features!
|
||||||
|
|
||||||
.. _optional from the standard library: http://en.cppreference.com/w/cpp/utility/optional
|
.. _optional from the standard library: http://en.cppreference.com/w/cpp/utility/optional
|
||||||
.. _this example here: https://github.com/ThePhD/sol2/blob/develop/examples/optional_with_iteration.cpp
|
.. _this example here: https://github.com/ThePhD/sol2/blob/develop/examples/source/optional_with_iteration.cpp
|
||||||
|
@ -59,4 +59,4 @@ Note that because of this system, you can use :doc:`sol::variadic_args<variadic_
|
|||||||
Please keep in mind that doing this bears a runtime cost to find the proper overload. The cost scales directly not exactly with the number of overloads, but the number of functions that have the same argument count as each other (sol will early-eliminate any functions that do not match the argument count).
|
Please keep in mind that doing this bears a runtime cost to find the proper overload. The cost scales directly not exactly with the number of overloads, but the number of functions that have the same argument count as each other (sol will early-eliminate any functions that do not match the argument count).
|
||||||
|
|
||||||
.. _luaL_check{number/udata/string}: http://www.Lua.org/manual/5.3/manual.html#luaL_checkinteger
|
.. _luaL_check{number/udata/string}: http://www.Lua.org/manual/5.3/manual.html#luaL_checkinteger
|
||||||
.. _This example shows how: https://github.com/ThePhD/sol2/blob/develop/examples/overloading_with_fallback.cpp
|
.. _This example shows how: https://github.com/ThePhD/sol2/blob/develop/examples/source/overloading_with_fallback.cpp
|
||||||
|
@ -326,4 +326,4 @@ This extension point is to ``get`` a foreign userdata. It should return both ``t
|
|||||||
.. _Lua stack works in general: https://www.lua.org/pil/24.2.html
|
.. _Lua stack works in general: https://www.lua.org/pil/24.2.html
|
||||||
.. _calling C functions works: https://www.lua.org/pil/26.html
|
.. _calling C functions works: https://www.lua.org/pil/26.html
|
||||||
.. _interop examples: https://github.com/ThePhD/sol2/blob/develop/examples/interop
|
.. _interop examples: https://github.com/ThePhD/sol2/blob/develop/examples/interop
|
||||||
.. _providing your own customization: https://github.com/ThePhD/sol2/blob/develop/examples/customization_convert_on_get.cpp
|
.. _providing your own customization: https://github.com/ThePhD/sol2/blob/develop/examples/source/customization_convert_on_get.cpp
|
||||||
|
@ -43,4 +43,4 @@ Sometimes in C++ it's useful to know where a Lua call is coming from and what :d
|
|||||||
|
|
||||||
Also see `this example`_ for more details.
|
Also see `this example`_ for more details.
|
||||||
|
|
||||||
.. _this example: https://github.com/ThePhD/sol2/blob/develop/examples/environment_snooping.cpp
|
.. _this example: https://github.com/ThePhD/sol2/blob/develop/examples/source/environment_snooping.cpp
|
@ -46,5 +46,5 @@ This will allow the library to properly handle ``boost::shared_ptr<T>``, with re
|
|||||||
If ``is_null`` triggers (returns ``true``), a ``nil`` value will be pushed into Lua rather than an empty structure.
|
If ``is_null`` triggers (returns ``true``), a ``nil`` value will be pushed into Lua rather than an empty structure.
|
||||||
|
|
||||||
|
|
||||||
.. _shared_ptr here: https://github.com/ThePhD/sol2/blob/develop/examples/shared_ptr.cpp
|
.. _shared_ptr here: https://github.com/ThePhD/sol2/blob/develop/examples/source/shared_ptr.cpp
|
||||||
.. _unique_ptr here: https://github.com/ThePhD/sol2/blob/develop/examples/unique_ptr.cpp
|
.. _unique_ptr here: https://github.com/ThePhD/sol2/blob/develop/examples/source/unique_ptr.cpp
|
||||||
|
@ -327,6 +327,6 @@ performance note
|
|||||||
|
|
||||||
.. _destructible: http://en.cppreference.com/w/cpp/types/is_destructible
|
.. _destructible: http://en.cppreference.com/w/cpp/types/is_destructible
|
||||||
.. _default_constructible: http://en.cppreference.com/w/cpp/types/is_constructible
|
.. _default_constructible: http://en.cppreference.com/w/cpp/types/is_constructible
|
||||||
.. _small starter example here: https://github.com/ThePhD/sol2/blob/develop/examples/usertype_basics.cpp
|
.. _small starter example here: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_basics.cpp
|
||||||
.. _runtime extensible: https://github.com/ThePhD/sol2/blob/develop/examples/usertype_advanced.cpp#L81
|
.. _runtime extensible: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_advanced.cpp#L81
|
||||||
.. _the metamethods in the Lua manual: https://www.lua.org/manual/5.3/manual.html#2.4
|
.. _the metamethods in the Lua manual: https://www.lua.org/manual/5.3/manual.html#2.4
|
||||||
|
@ -8,4 +8,4 @@ variadic_results
|
|||||||
|
|
||||||
This type allows someone to prepare multiple returns before returning them into Lua. It derives from ``std::vector``, so it can be used exactly like that, and objects can be added using the various constructors and functions relating to :doc:`sol::object<object>`. You can see it and other return-type helpers in action `here`_.
|
This type allows someone to prepare multiple returns before returning them into Lua. It derives from ``std::vector``, so it can be used exactly like that, and objects can be added using the various constructors and functions relating to :doc:`sol::object<object>`. You can see it and other return-type helpers in action `here`_.
|
||||||
|
|
||||||
.. _here: https://github.com/ThePhD/sol2/blob/develop/examples/multi_results.cpp
|
.. _here: https://github.com/ThePhD/sol2/blob/develop/examples/source/multi_results.cpp
|
||||||
|
@ -241,5 +241,5 @@ If you can't upgrade, use the "member" function ``my_container:pairs()`` in Lua
|
|||||||
:linenos:
|
:linenos:
|
||||||
|
|
||||||
.. _online version's information: https://www.lua.org/pil/26.html
|
.. _online version's information: https://www.lua.org/pil/26.html
|
||||||
.. _reflect changes if you use a reference: https://github.com/ThePhD/sol2/blob/develop/examples/containers.cpp
|
.. _reflect changes if you use a reference: https://github.com/ThePhD/sol2/blob/develop/examples/source/containers.cpp
|
||||||
.. _this table serialization example: https://github.com/ThePhD/sol2/blob/develop/examples/containers_as_table.cpp
|
.. _this table serialization example: https://github.com/ThePhD/sol2/blob/develop/examples/source/containers_as_table.cpp
|
||||||
|
@ -104,4 +104,4 @@ Tables may have other junk on them that makes iterating through their numeric pa
|
|||||||
.. _OrfeasZ in this issue: https://github.com/ThePhD/sol2/issues/329#issuecomment-276824983
|
.. _OrfeasZ in this issue: https://github.com/ThePhD/sol2/issues/329#issuecomment-276824983
|
||||||
.. _this issue for fixes to this behavior: https://github.com/ThePhD/sol2/issues/414#issuecomment-306839439
|
.. _this issue for fixes to this behavior: https://github.com/ThePhD/sol2/issues/414#issuecomment-306839439
|
||||||
.. _this __stdcall issue report: https://github.com/ThePhD/sol2/issues/463
|
.. _this __stdcall issue report: https://github.com/ThePhD/sol2/issues/463
|
||||||
.. _the simple usertype example here: https://github.com/ThePhD/sol2/blob/develop/examples/usertype_simple.cpp#L45
|
.. _the simple usertype example here: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_simple.cpp#L45
|
||||||
|
@ -104,5 +104,5 @@ Note that stateless lambdas can be converted to a function pointer, so stateless
|
|||||||
Do NOT assume that building Lua as C++ will allow you to throw directly from a raw function. If an exception is raised and it bubbles into the Lua framework, even if you compile as C++, Lua does not recognize exceptions other than the ones that it uses with ``lua_error``. In other words, it will return some completely bogus result, potentially leave your Lua stack thrashed, and the rest of your VM *can* be in a semi-trashed state. Please avoid this!
|
Do NOT assume that building Lua as C++ will allow you to throw directly from a raw function. If an exception is raised and it bubbles into the Lua framework, even if you compile as C++, Lua does not recognize exceptions other than the ones that it uses with ``lua_error``. In other words, it will return some completely bogus result, potentially leave your Lua stack thrashed, and the rest of your VM *can* be in a semi-trashed state. Please avoid this!
|
||||||
|
|
||||||
|
|
||||||
.. _the examples: https://github.com/ThePhD/sol2/blob/develop/examples/functions.cpp
|
.. _the examples: https://github.com/ThePhD/sol2/blob/develop/examples/source/functions.cpp
|
||||||
.. _avoid the nightmare altogether: https://github.com/ThePhD/sol2/issues/608#issuecomment-372876206
|
.. _avoid the nightmare altogether: https://github.com/ThePhD/sol2/issues/608#issuecomment-372876206
|
||||||
|
@ -79,5 +79,5 @@ Next, let's start :doc:`reading/writing some variables<variables>` from Lua into
|
|||||||
.. _single/sol/sol.hpp: https://github.com/ThePhD/sol2/blob/develop/single/sol/sol.hpp
|
.. _single/sol/sol.hpp: https://github.com/ThePhD/sol2/blob/develop/single/sol/sol.hpp
|
||||||
.. _github repository here: https://github.com/ThePhD/sol2
|
.. _github repository here: https://github.com/ThePhD/sol2
|
||||||
.. _Lua page on getting started: https://www.lua.org/start.html
|
.. _Lua page on getting started: https://www.lua.org/start.html
|
||||||
.. _in this example: https://github.com/ThePhD/sol2/blob/develop/examples/basic.cpp
|
.. _in this example: https://github.com/ThePhD/sol2/blob/develop/examples/source/basic.cpp
|
||||||
.. _example of loading a DLL: https://github.com/ThePhD/sol2/tree/develop/examples/require_dll_example
|
.. _example of loading a DLL: https://github.com/ThePhD/sol2/tree/develop/examples/require_dll_example
|
||||||
|
@ -61,9 +61,9 @@ Here are some other general advice and tips for understanding and dealing with u
|
|||||||
* The actual metatable associated with the usertype has a long name and is defined to be opaque by the sol implementation.
|
* The actual metatable associated with the usertype has a long name and is defined to be opaque by the sol implementation.
|
||||||
* The actual metatable inner workings is opaque and defined by the sol implementation, and there are no internal docs because optimizations on the operations are applied based on heuristics we discover from performance testing the system.
|
* The actual metatable inner workings is opaque and defined by the sol implementation, and there are no internal docs because optimizations on the operations are applied based on heuristics we discover from performance testing the system.
|
||||||
|
|
||||||
.. _here, that uses a few tricks: https://github.com/ThePhD/sol2/blob/develop/examples/usertype_bitfields.cpp
|
.. _here, that uses a few tricks: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_bitfields.cpp
|
||||||
.. _Lua: https://github.com/ThePhD/sol2/blob/develop/examples/usertype_advanced.cpp#L81
|
.. _Lua: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_advanced.cpp#L81
|
||||||
.. _C++: https://github.com/ThePhD/sol2/blob/develop/examples/usertype_simple.cpp#L51
|
.. _C++: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_simple.cpp#L51
|
||||||
.. _Certain operators: https://github.com/ThePhD/sol2/blob/develop/examples/usertype_automatic_operators.cpp
|
.. _Certain operators: https://github.com/ThePhD/sol2/blob/develop/examples/source/usertype_automatic_operators.cpp
|
||||||
.. _dynamic_object example: https://github.com/ThePhD/sol2/blob/develop/examples/dynamic_object.cpp
|
.. _dynamic_object example: https://github.com/ThePhD/sol2/blob/develop/examples/source/dynamic_object.cpp
|
||||||
.. _as shown in the pairs example: https://github.com/ThePhD/sol2/blob/develop/examples/pairs.cpp
|
.. _as shown in the pairs example: https://github.com/ThePhD/sol2/blob/develop/examples/source/pairs.cpp
|
||||||
|
Loading…
x
Reference in New Issue
Block a user