summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 14:49:10 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:21 +0100
commit002dc5a6b97a742bce0035c9ed33919df06c2779 (patch)
treec97861993d81e05813d66b0d622d4a08976e4ab6
parent8f7c9a3b2606f3a582a284286bb77e743f02c1e1 (diff)
downloadefl-002dc5a6b97a742bce0035c9ed33919df06c2779.tar.gz
elua lib: add state_free doc
-rw-r--r--src/lib/elua/Elua.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index e764750c1c..84d243baa9 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -166,6 +166,16 @@ EAPI Elua_State *elua_state_new(const char *progname);
*/
EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L);
+/**
+ * @brief Destroy an Elua state.
+ *
+ * Given an Elua state, this destroys its internal Lua state as well as all
+ * other data its holding and then frees the Elua state itself.
+ *
+ * @param[in] es The Elua state.
+ *
+ * @ingroup Elua
+ */
EAPI void elua_state_free(Elua_State *es);
EAPI void elua_state_dirs_set(Elua_State *es, const char *core,