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

elua lib: docs for elua_io_loadfile
---

diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index 83441ea7bd..0a165678df 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -347,6 +347,18 @@ EAPI Eina_Bool elua_state_modules_setup(const Elua_State *es);
  */
 EAPI Eina_Bool elua_state_io_setup(const Elua_State *es);
 
+/**
+ * @brief Loads a file using Elua's own mmap-based IO.
+ *
+ * This function behaves identically to luaL_loadfile when it comes to
+ * semantics. The loaded file remains on the Lua stack.
+ *
+ * @param[in] es The Elua state.
+ * @param[in] fname The file name.
+ * @return 0 for no errors, a non-zero value for errors (-1 for NULL es).
+ *
+ * @ingroup Elua
+ */
 EAPI int elua_io_loadfile(const Elua_State *es, const char *fname);
 
 EAPI int elua_util_require(Elua_State *es, const char *libname);