summaryrefslogtreecommitdiff
path: root/src/lib/elua
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 15:06:01 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:22 +0100
commit4d6f254885f53ed545f7cf9d0cd6b19e4d5bb234 (patch)
tree9fa25e04d3d3cac22003f30bd1fa96ddbaf1807d /src/lib/elua
parenteab576db611e3f067f5c4e4659b61eefb7a52ced (diff)
elua lib: add docs for the dir retrieval APIs.
Diffstat (limited to 'src/lib/elua')
-rw-r--r--src/lib/elua/Elua.h23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index 7c478f8516..7f27ba8df8 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -223,8 +223,31 @@ EAPI void elua_state_dirs_set(Elua_State *es, const char *core,
223 */ 223 */
224EAPI 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);
225 225
226/**
227 * @brief Retrieve the Elua core dir.
228 *
229 * @param[in] es The Elua state.
230 *
231 * @ingroup Elua
232 */
226EAPI Eina_Stringshare *elua_state_core_dir_get(const Elua_State *es); 233EAPI Eina_Stringshare *elua_state_core_dir_get(const Elua_State *es);
234
235/**
236 * @brief Retrieve the Elua module dir.
237 *
238 * @param[in] es The Elua state.
239 *
240 * @ingroup Elua
241 */
227EAPI Eina_Stringshare *elua_state_mod_dir_get(const Elua_State *es); 242EAPI Eina_Stringshare *elua_state_mod_dir_get(const Elua_State *es);
243
244/**
245 * @brief Retrieve the Elua apps dir.
246 *
247 * @param[in] es The Elua state.
248 *
249 * @ingroup Elua
250 */
228EAPI Eina_Stringshare *elua_state_apps_dir_get(const Elua_State *es); 251EAPI Eina_Stringshare *elua_state_apps_dir_get(const Elua_State *es);
229 252
230EAPI Eina_Stringshare *elua_state_prog_name_get(const Elua_State *es); 253EAPI Eina_Stringshare *elua_state_prog_name_get(const Elua_State *es);