From 098b135799ce3516258024f62e6f5b3bd2ff7d18 Mon Sep 17 00:00:00 2001 From: Daniel Kolesa Date: Mon, 20 Apr 2015 16:35:55 +0100 Subject: elua lib: docs for elua_state_io_setup --- src/lib/elua/Elua.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'src/lib/elua') diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h index 6feb2dd79e..83441ea7bd 100644 --- a/src/lib/elua/Elua.h +++ b/src/lib/elua/Elua.h @@ -333,6 +333,18 @@ EAPI Eina_Bool elua_state_i18n_setup(const Elua_State *es); * @ingroup Elua */ EAPI Eina_Bool elua_state_modules_setup(const Elua_State *es); + +/** + * @brief Set up IO support for an Elua state. + * + * Elua provides its own loadfile based around mmap to replace the less + * efficient Lua version. This function takes care of the setup. + * + * @param[in] es The Elua state. + * @return EINA_TRUE on success, EINA_FALSE on failure. + * + * @ingroup Elua + */ EAPI Eina_Bool elua_state_io_setup(const Elua_State *es); EAPI int elua_io_loadfile(const Elua_State *es, const char *fname); -- cgit v1.2.1