summaryrefslogtreecommitdiff
path: root/src/lib/elua
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 14:47:47 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:21 +0100
commit8f7c9a3b2606f3a582a284286bb77e743f02c1e1 (patch)
tree04839116c5acf226977bbba46d7f2aa24a66860a /src/lib/elua
parent8b6dd5a417d67ae4842bf0de50a974881214bf08 (diff)
elua lib: add state_from_lua_state_get doc
Diffstat (limited to 'src/lib/elua')
-rw-r--r--src/lib/elua/Elua.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index c88d20997a..e764750c1c 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -150,6 +150,20 @@ EAPI int elua_shutdown(void);
150 * @ingroup Elua 150 * @ingroup Elua
151 */ 151 */
152EAPI Elua_State *elua_state_new(const char *progname); 152EAPI Elua_State *elua_state_new(const char *progname);
153
154/**
155 * @brief Retrieve an Elua state from a Lua state.
156 *
157 * This doesn't create a new Elua state. Instead it just retrieves an existing
158 * Elua state given a Lua state. If no Elua state could be found (for example
159 * when the Lua state was created independently of Elua), this function returns
160 * NULL.
161 *
162 * @param[in] L The Lua state.
163 * @return An Elua state or NULL.
164 *
165 * @ingroup Elua
166 */
153EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L); 167EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L);
154 168
155EAPI void elua_state_free(Elua_State *es); 169EAPI void elua_state_free(Elua_State *es);