summaryrefslogtreecommitdiff
path: root/src/lib/elua
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 14:45:08 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:21 +0100
commit8b6dd5a417d67ae4842bf0de50a974881214bf08 (patch)
tree47e7130c0c38c1938549fcffd9a01dce2addd9fd /src/lib/elua
parentf16f21f37d926cc87b3ea8dcc03538e6f9aa4a7c (diff)
elua lib: add state_new 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 4588bcb8ab..c88d20997a 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -135,6 +135,20 @@ EAPI int elua_init(void);
135 */ 135 */
136EAPI int elua_shutdown(void); 136EAPI int elua_shutdown(void);
137 137
138/**
139 * @brief Create a new Elua state.
140 *
141 * This creates a new Elua state. An Elua state is externally opaque, but
142 * it contains a LuaJIT state as well as some additional information that
143 * is mostly initialized by other APIs.
144 *
145 * @param[in] progname The program name that holds the Elua state. This will
146 * be used for stuff like error reporting. Typically the same as the binary
147 * name of the application (argv[0]).
148 * @return A new Elua state or NULL.
149 *
150 * @ingroup Elua
151 */
138EAPI Elua_State *elua_state_new(const char *progname); 152EAPI Elua_State *elua_state_new(const char *progname);
139EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L); 153EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L);
140 154