elua lib: docs for elua_state_modules_setup
authorDaniel Kolesa <d.kolesa@osg.samsung.com>
Mon, 20 Apr 2015 15:34:35 +0000 (16:34 +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 23ec100..6feb2dd 100644 (file)
@@ -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);