summaryrefslogtreecommitdiff
path: root/src/lib/elua
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 15:03:53 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:22 +0100
commiteab576db611e3f067f5c4e4659b61eefb7a52ced (patch)
tree0364570ad1d0eb4742819bf2aae352e17e18639d /src/lib/elua
parentfcf865f7ae26460aa624a2be12595aee263d55f0 (diff)
elua lib: add doc for elua_state_dirs_fill
Diffstat (limited to 'src/lib/elua')
-rw-r--r--src/lib/elua/Elua.h21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index b824b75e59..7c478f8516 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -187,6 +187,10 @@ EAPI void elua_state_free(Elua_State *es);
187 * where extra modules will be loaded and the apps path refers to from where 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). 188 * Elua applications will be loaded (this is not a module path).
189 * 189 *
190 * If you provide NULL for any path, it will not be set. This allows you to
191 * split the setting into multiple calls. By the time of state use all need
192 * to be set.
193 *
190 * @param[in] es The Elua state. 194 * @param[in] es The Elua state.
191 * @param[in] core The core path. 195 * @param[in] core The core path.
192 * @param[in] mods The modules path. 196 * @param[in] mods The modules path.
@@ -200,6 +204,23 @@ EAPI void elua_state_free(Elua_State *es);
200 */ 204 */
201EAPI void elua_state_dirs_set(Elua_State *es, const char *core, 205EAPI void elua_state_dirs_set(Elua_State *es, const char *core,
202 const char *mods, const char *apps); 206 const char *mods, const char *apps);
207
208/**
209 * @brief Fill the currently unset Elua dirs.
210 *
211 * This checks if any of the three main paths are unset and tries to fill
212 * them from the environment. It first tries environment variables to fill
213 * them (ELUA_CORE_DIR, ELUA_MODULES_DIR, ELUA_APPS_DIR) unless the ignore_env
214 * param is EINA_TRUE. If it is (or if the environment vars weren't set right)
215 * it uses eina prefix of the library to determine the paths. In that case
216 * they will expand to DATADIR/core, DATADIR/modules and DATADIR/apps, where
217 * DATADIR is typically something like /usr/share/elua.
218 *
219 * @param[in] es The Elua state.
220 * @param[in] ignore_env If set to EINA_TRUE, this ignores the env vars.
221 *
222 * @ingroup Elua
223 */
203EAPI void elua_state_dirs_fill(Elua_State *es, Eina_Bool ignore_env); 224EAPI void elua_state_dirs_fill(Elua_State *es, Eina_Bool ignore_env);
204 225
205EAPI Eina_Stringshare *elua_state_core_dir_get(const Elua_State *es); 226EAPI Eina_Stringshare *elua_state_core_dir_get(const Elua_State *es);