From 8f7c9a3b2606f3a582a284286bb77e743f02c1e1 Mon Sep 17 00:00:00 2001 From: Daniel Kolesa Date: Mon, 20 Apr 2015 14:47:47 +0100 Subject: [PATCH] elua lib: add state_from_lua_state_get doc --- src/lib/elua/Elua.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h index c88d209..e764750 100644 --- a/src/lib/elua/Elua.h +++ b/src/lib/elua/Elua.h @@ -150,6 +150,20 @@ EAPI int elua_shutdown(void); * @ingroup Elua */ EAPI Elua_State *elua_state_new(const char *progname); + +/** + * @brief Retrieve an Elua state from a Lua state. + * + * This doesn't create a new Elua state. Instead it just retrieves an existing + * Elua state given a Lua state. If no Elua state could be found (for example + * when the Lua state was created independently of Elua), this function returns + * NULL. + * + * @param[in] L The Lua state. + * @return An Elua state or NULL. + * + * @ingroup Elua + */ EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L); EAPI void elua_state_free(Elua_State *es); -- 2.7.4