From fcf865f7ae26460aa624a2be12595aee263d55f0 Mon Sep 17 00:00:00 2001 From: Daniel Kolesa Date: Mon, 20 Apr 2015 14:57:43 +0100 Subject: [PATCH] elua lib: add docs for elua_state_dirs_set --- src/lib/elua/Elua.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h index 84d243baa9..b824b75e59 100644 --- a/src/lib/elua/Elua.h +++ b/src/lib/elua/Elua.h @@ -178,6 +178,26 @@ EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L); */ EAPI void elua_state_free(Elua_State *es); +/** + * @brief Set the Elua directory paths. + * + * Every Elua state needs three paths - the core script path, the module + * path and the apps path. The core path refers to from where core scripts + * will be loaded (such as the module system), the module path refers to from + * where extra modules will be loaded and the apps path refers to from where + * Elua applications will be loaded (this is not a module path). + * + * @param[in] es The Elua state. + * @param[in] core The core path. + * @param[in] mods The modules path. + * @param[in] apps The apps path. + * + * @see elua_state_core_dir_get + * @see elua_state_mod_dir_get + * @see elua_state_apps_dir_get + * + * @ingroup Elua + */ EAPI void elua_state_dirs_set(Elua_State *es, const char *core, const char *mods, const char *apps); EAPI void elua_state_dirs_fill(Elua_State *es, Eina_Bool ignore_env); -- 2.34.1