From 1bc450402f9125e2138eb5d29ce014510b910494 Mon Sep 17 00:00:00 2001 From: Daniel Kolesa Date: Mon, 20 Apr 2015 16:49:53 +0100 Subject: [PATCH] elua lib: docs for elua_util_require --- src/lib/elua/Elua.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) 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); */ EAPI int elua_io_loadfile(const Elua_State *es, const char *fname); +/** + * @brief Requires a module. + * + * Requires a Lua module. Leaves the Lua stack clean. Returns 0 on success + * or non-zero value on failure (see lua_pcall). + * + * @param[in] es The Elua state. + * @param[in] libname The library name. + * @return 0 for no errors, a non-zero value for errors (-1 for NULL es or + * NULL require). + * + * @ingroup Elua + */ EAPI int elua_util_require(Elua_State *es, const char *libname); EAPI int elua_util_file_run(Elua_State *es, const char *fname); EAPI int elua_util_string_run(Elua_State *es, const char *chunk, -- 2.34.1