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

elua lib: docs for elua_util_string_run
---

diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index a1ba8a7dac..5b9981969b 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -389,6 +389,19 @@ EAPI int elua_util_require(Elua_State *es, const char *libname);
  * @ingroup Elua
  */
 EAPI int elua_util_file_run(Elua_State *es, const char *fname);
+
+/**
+ * @brief Runs a string.
+ *
+ * Runs a string. Returns zero on success or non-zero value on failure.
+ *
+ * @param[in] es The Elua state.
+ * @param[in] chunk The string to run.
+ * @param[in] chname The chunk name to use for traceback/debug.
+ * @return 0 for no errors, a non-zero value for errors (-1 for NULL es).
+ *
+ * @ingroup Elua
+ */
 EAPI int elua_util_string_run(Elua_State *es, const char *chunk,
                               const char *chname);
 EAPI Eina_Bool elua_util_app_load(Elua_State *es, const char *appname);