diff options
| author | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-04-20 14:49:10 +0100 |
|---|---|---|
| committer | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-05-06 15:05:21 +0100 |
| commit | 002dc5a6b97a742bce0035c9ed33919df06c2779 (patch) | |
| tree | c97861993d81e05813d66b0d622d4a08976e4ab6 /src/lib | |
| parent | 8f7c9a3b2606f3a582a284286bb77e743f02c1e1 (diff) | |
elua lib: add state_free doc
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/elua/Elua.h | 10 |
1 files changed, 10 insertions, 0 deletions
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); | |||
| 166 | */ | 166 | */ |
| 167 | EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L); | 167 | EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L); |
| 168 | 168 | ||
| 169 | /** | ||
| 170 | * @brief Destroy an Elua state. | ||
| 171 | * | ||
| 172 | * Given an Elua state, this destroys its internal Lua state as well as all | ||
| 173 | * other data its holding and then frees the Elua state itself. | ||
| 174 | * | ||
| 175 | * @param[in] es The Elua state. | ||
| 176 | * | ||
| 177 | * @ingroup Elua | ||
| 178 | */ | ||
| 169 | EAPI void elua_state_free(Elua_State *es); | 179 | EAPI void elua_state_free(Elua_State *es); |
| 170 | 180 | ||
| 171 | EAPI void elua_state_dirs_set(Elua_State *es, const char *core, | 181 | EAPI void elua_state_dirs_set(Elua_State *es, const char *core, |