summaryrefslogtreecommitdiff
path: root/src/lib/elua
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 16:51:25 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:22 +0100
commitf9520f7974424eaa3c5a33d7c81f555cfc82fca1 (patch)
tree2d8fd4ad9d88c829a2616c032ddd1c873ecadf65 /src/lib/elua
parent1bc450402f9125e2138eb5d29ce014510b910494 (diff)
elua lib: docs for elua_util_file_run
Diffstat (limited to 'src/lib/elua')
-rw-r--r--src/lib/elua/Elua.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index c4c965fd79..a1ba8a7dac 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -375,6 +375,19 @@ EAPI int elua_io_loadfile(const Elua_State *es, const char *fname);
375 * @ingroup Elua 375 * @ingroup Elua
376 */ 376 */
377EAPI int elua_util_require(Elua_State *es, const char *libname); 377EAPI int elua_util_require(Elua_State *es, const char *libname);
378
379/**
380 * @brief Runs a file.
381 *
382 * Runs a file. Uses the Elua mmapped file IO to load the file. Returns zero
383 * on success or non-zero value on failure.
384 *
385 * @param[in] es The Elua state.
386 * @param[in] fname The file name.
387 * @return 0 for no errors, a non-zero value for errors (-1 for NULL es).
388 *
389 * @ingroup Elua
390 */
378EAPI int elua_util_file_run(Elua_State *es, const char *fname); 391EAPI int elua_util_file_run(Elua_State *es, const char *fname);
379EAPI int elua_util_string_run(Elua_State *es, const char *chunk, 392EAPI int elua_util_string_run(Elua_State *es, const char *chunk,
380 const char *chname); 393 const char *chname);