elua lib: add docs for the dir retrieval APIs.
authorDaniel Kolesa <d.kolesa@osg.samsung.com>
Mon, 20 Apr 2015 14:06:01 +0000 (15:06 +0100)
committerDaniel Kolesa <d.kolesa@osg.samsung.com>
Wed, 6 May 2015 14:05:22 +0000 (15:05 +0100)
src/lib/elua/Elua.h

index 7c478f8..7f27ba8 100644 (file)
@@ -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);