From: Daniel Kolesa <d.kolesa@osg.samsung.com>
Date: Mon, 20 Apr 2015 15:34:35 +0000 (+0100)
Subject: elua lib: docs for elua_state_modules_setup
X-Git-Tag: v1.15.0-alpha1~752^2~18
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=123955994b05bb3bef3c32e299b95f51107b7b34;p=platform%2Fupstream%2Fefl.git

elua lib: docs for elua_state_modules_setup
---

diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index 23ec100b1a..6feb2dd79e 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -320,6 +320,18 @@ EAPI lua_State *elua_state_lua_state_get(const Elua_State *es);
  * @ingroup Elua
  */
 EAPI Eina_Bool elua_state_i18n_setup(const Elua_State *es);
+
+/**
+ * @brief Set up module support for an Elua state.
+ *
+ * This loads the Elua module system and makes Lua aware of it. It also
+ * registers the Elua C utility library module.
+ *
+ * @param[in] es The Elua state.
+ * @return EINA_TRUE on success, EINA_FALSE on failure.
+ *
+ * @ingroup Elua
+ */
 EAPI Eina_Bool elua_state_modules_setup(const Elua_State *es);
 EAPI Eina_Bool elua_state_io_setup(const Elua_State *es);