summaryrefslogtreecommitdiff
path: root/src/lib/elua
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 16:49:53 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:22 +0100
commit1bc450402f9125e2138eb5d29ce014510b910494 (patch)
tree73ffdd02a3be0a3c22b3ddbd3ca1cfee15900049 /src/lib/elua
parent2a8eb85dff62684b80fdea6dc5d609b9723b8e49 (diff)
elua lib: docs for elua_util_require
Diffstat (limited to 'src/lib/elua')
-rw-r--r--src/lib/elua/Elua.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index 0a165678df..c4c965fd79 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -361,6 +361,19 @@ EAPI Eina_Bool elua_state_io_setup(const Elua_State *es);
361 */ 361 */
362EAPI int elua_io_loadfile(const Elua_State *es, const char *fname); 362EAPI int elua_io_loadfile(const Elua_State *es, const char *fname);
363 363
364/**
365 * @brief Requires a module.
366 *
367 * Requires a Lua module. Leaves the Lua stack clean. Returns 0 on success
368 * or non-zero value on failure (see lua_pcall).
369 *
370 * @param[in] es The Elua state.
371 * @param[in] libname The library name.
372 * @return 0 for no errors, a non-zero value for errors (-1 for NULL es or
373 * NULL require).
374 *
375 * @ingroup Elua
376 */
364EAPI int elua_util_require(Elua_State *es, const char *libname); 377EAPI int elua_util_require(Elua_State *es, const char *libname);
365EAPI int elua_util_file_run(Elua_State *es, const char *fname); 378EAPI int elua_util_file_run(Elua_State *es, const char *fname);
366EAPI int elua_util_string_run(Elua_State *es, const char *chunk, 379EAPI int elua_util_string_run(Elua_State *es, const char *chunk,