elua lib: docs for elua_state_require_ref_push
authorDaniel Kolesa <d.kolesa@osg.samsung.com>
Mon, 20 Apr 2015 15:10:31 +0000 (16:10 +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 32c7af184d438d4d39ff7afc7ef798636d2972f8..3f9a114befce322c551740b5e50f6bf673897fc2 100644 (file)
@@ -272,6 +272,14 @@ EAPI Eina_Stringshare *elua_state_prog_name_get(const Elua_State *es);
  */
 EAPI void elua_state_include_path_add(Elua_State *es, const char *path);
 
+/**
+ * @brief Push the Elua "require" function onto the Lua stack.
+ *
+ * @param[in] es The Elua state.
+ * @return EINA_TRUE if the push was successful, EINA_FALSE otherwise.
+ *
+ * @ingroup Elua
+ */
 EAPI Eina_Bool elua_state_require_ref_push(Elua_State *es);
 EAPI Eina_Bool elua_state_appload_ref_push(Elua_State *es);