From 4d6f254885f53ed545f7cf9d0cd6b19e4d5bb234 Mon Sep 17 00:00:00 2001 From: Daniel Kolesa Date: Mon, 20 Apr 2015 15:06:01 +0100 Subject: [PATCH] elua lib: add docs for the dir retrieval APIs. --- src/lib/elua/Elua.h | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h index 7c478f8..7f27ba8 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, */ EAPI void elua_state_dirs_fill(Elua_State *es, Eina_Bool ignore_env); +/** + * @brief Retrieve the Elua core dir. + * + * @param[in] es The Elua state. + * + * @ingroup Elua + */ EAPI Eina_Stringshare *elua_state_core_dir_get(const Elua_State *es); + +/** + * @brief Retrieve the Elua module dir. + * + * @param[in] es The Elua state. + * + * @ingroup Elua + */ EAPI Eina_Stringshare *elua_state_mod_dir_get(const Elua_State *es); + +/** + * @brief Retrieve the Elua apps dir. + * + * @param[in] es The Elua state. + * + * @ingroup Elua + */ EAPI Eina_Stringshare *elua_state_apps_dir_get(const Elua_State *es); EAPI Eina_Stringshare *elua_state_prog_name_get(const Elua_State *es); -- 2.7.4