From 8bd25cc966e2f2ab179d562c1f7845b744e475fd Mon Sep 17 00:00:00 2001 From: Daniel Kolesa Date: Mon, 20 Apr 2015 16:12:22 +0100 Subject: [PATCH] elua lib: docs for elua_state_lua_state_get --- src/lib/elua/Elua.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h index ffc3184..4d3e1c9 100644 --- a/src/lib/elua/Elua.h +++ b/src/lib/elua/Elua.h @@ -292,6 +292,18 @@ EAPI Eina_Bool elua_state_require_ref_push(Elua_State *es); */ EAPI Eina_Bool elua_state_appload_ref_push(Elua_State *es); +/** + * @brief Retrieve the Lua state from an Elua state. + * + * This function retrieves the Lua state from a valid Elua state. As an + * Elua state is always initialized, this will return a valid state, unless + * the given Elua state is NULL, in which case it will also return NULL. + * + * @param[in] es The Elua state. + * @return The Lua state or NULL. + * + * @ingroup Elua + */ EAPI lua_State *elua_state_lua_state_get(const Elua_State *es); EAPI Eina_Bool elua_state_i18n_setup(const Elua_State *es); -- 2.7.4