From: Daniel Kolesa <d.kolesa@osg.samsung.com>
Date: Mon, 20 Apr 2015 14:06:01 +0000 (+0100)
Subject: elua lib: add docs for the dir retrieval APIs.
X-Git-Tag: v1.15.0-alpha1~752^2~25
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4d6f254885f53ed545f7cf9d0cd6b19e4d5bb234;p=platform%2Fupstream%2Fefl.git

elua lib: add docs for the dir retrieval APIs.
---

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,
  */
 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);