elua lib: docs for elua_util_app_load

1 files changed, 13 insertions, 0 deletions

diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index 5b9981969b..58cb104a70 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -404,6 +404,19 @@ EAPI int elua_util_file_run(Elua_State *es, const char *fname);
  */
 EAPI int elua_util_string_run(Elua_State *es, const char *chunk,
                               const char *chname);
+
+/**
+ * @brief Loads an application.
+ *
+ * This loads an app, respecting the app path set on state initialization.
+ * Leaves the Lua stack clean. Actually runs the app.
+ *
+ * @param[in] es The Elua state.
+ * @param[in] appname The application name.
+ * @return EINA_TRUE on success, EINA_FALSE on failure.
+ *
+ * @ingroup Elua
+ */
 EAPI Eina_Bool elua_util_app_load(Elua_State *es, const char *appname);
 EAPI int elua_util_script_run(Elua_State *es, int argc, char **argv, int n,
                               int *quit);