From 002dc5a6b97a742bce0035c9ed33919df06c2779 Mon Sep 17 00:00:00 2001 From: Daniel Kolesa Date: Mon, 20 Apr 2015 14:49:10 +0100 Subject: [PATCH] elua lib: add state_free doc --- src/lib/elua/Elua.h | 10 ++++++++++ 1 file changed, 10 insertions(+) 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, -- 2.34.1