aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/api-top.rst
diff options
context:
space:
mode:
authorAndy <drumsetmonkey@gmail.com>2019-08-29 13:07:45 -0400
committerAndy <drumsetmonkey@gmail.com>2019-08-29 13:07:45 -0400
commit4ac4b280abf2ffa28caa5a532353115a3033444f (patch)
tree2a13d658bb454360b2faf401244bb0321d3460d4 /lib/sol2/docs/source/api/api-top.rst
parente9758416b18b27a65337c28d9641afc0ee89b34b (diff)
parent7a46fa2dd3dad3f038bf8e7339bc67abca428ae6 (diff)
Started creating scripting library/namespace and added sol2 for interfacing
Diffstat (limited to 'lib/sol2/docs/source/api/api-top.rst')
-rw-r--r--lib/sol2/docs/source/api/api-top.rst57
1 files changed, 57 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/api/api-top.rst b/lib/sol2/docs/source/api/api-top.rst
new file mode 100644
index 0000000..257ea9c
--- /dev/null
+++ b/lib/sol2/docs/source/api/api-top.rst
@@ -0,0 +1,57 @@
+api reference manual
+====================
+
+Browse the various function and classes :doc:`sol<../index>` utilizes to make your life easier when working with Lua.
+
+
+.. toctree::
+ :caption: sol API
+ :name: apitoc
+ :maxdepth: 2
+
+ state
+ this_state
+ lua_value
+ reference
+ stack_reference
+ make_reference
+ table
+ table_traversal_keys
+ userdata
+ environment
+ this_environment
+ proxy
+ as_container
+ nested
+ as_table
+ usertype
+ usertype_memory
+ unique_usertype_traits
+ tie
+ function
+ protected_function
+ coroutine
+ yielding
+ error
+ object
+ thread
+ optional
+ variadic_args
+ variadic_results
+ as_args
+ as_returns
+ overload
+ property
+ var
+ protect
+ policies
+ readonly
+ as_function
+ c_call
+ resolve
+ stack
+ user
+ compatibility
+ types
+ metatable_key
+ new_table