elua lib: add state_from_lua_state_get doc

This commit is contained in:
Daniel Kolesa 2015-04-20 14:47:47 +01:00
parent 8b6dd5a417
commit 8f7c9a3b26
1 changed files with 14 additions and 0 deletions

View File

@ -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);