diff options
author | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-04-20 14:57:43 +0100 |
---|---|---|
committer | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-05-06 15:05:21 +0100 |
commit | fcf865f7ae26460aa624a2be12595aee263d55f0 (patch) | |
tree | 501de00910ad3f31ae20b9214f7e4c8af3650916 | |
parent | 002dc5a6b97a742bce0035c9ed33919df06c2779 (diff) |
elua lib: add docs for elua_state_dirs_set
-rw-r--r-- | src/lib/elua/Elua.h | 20 |
1 files changed, 20 insertions, 0 deletions
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); | |||
178 | */ | 178 | */ |
179 | EAPI void elua_state_free(Elua_State *es); | 179 | EAPI void elua_state_free(Elua_State *es); |
180 | 180 | ||
181 | /** | ||
182 | * @brief Set the Elua directory paths. | ||
183 | * | ||
184 | * Every Elua state needs three paths - the core script path, the module | ||
185 | * path and the apps path. The core path refers to from where core scripts | ||
186 | * will be loaded (such as the module system), the module path refers to from | ||
187 | * where extra modules will be loaded and the apps path refers to from where | ||
188 | * Elua applications will be loaded (this is not a module path). | ||
189 | * | ||
190 | * @param[in] es The Elua state. | ||
191 | * @param[in] core The core path. | ||
192 | * @param[in] mods The modules path. | ||
193 | * @param[in] apps The apps path. | ||
194 | * | ||
195 | * @see elua_state_core_dir_get | ||
196 | * @see elua_state_mod_dir_get | ||
197 | * @see elua_state_apps_dir_get | ||
198 | * | ||
199 | * @ingroup Elua | ||
200 | */ | ||
181 | EAPI void elua_state_dirs_set(Elua_State *es, const char *core, | 201 | EAPI void elua_state_dirs_set(Elua_State *es, const char *core, |
182 | const char *mods, const char *apps); | 202 | const char *mods, const char *apps); |
183 | EAPI void elua_state_dirs_fill(Elua_State *es, Eina_Bool ignore_env); | 203 | EAPI void elua_state_dirs_fill(Elua_State *es, Eina_Bool ignore_env); |