diff options
author | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-04-20 14:41:50 +0100 |
---|---|---|
committer | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-05-06 15:05:21 +0100 |
commit | f16f21f37d926cc87b3ea8dcc03538e6f9aa4a7c (patch) | |
tree | a7ef6dbfc8da98688cb5b2197df2e656e40fda73 /src/lib/elua | |
parent | 81e3f753da5ab2edc3a0cb2ba7576dffbb0863ed (diff) | |
download | efl-f16f21f37d926cc87b3ea8dcc03538e6f9aa4a7c.tar.gz |
elua lib: add init/shutdown doc
Diffstat (limited to 'src/lib/elua')
-rw-r--r-- | src/lib/elua/Elua.h | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h index bd4b20ba1c..4588bcb8ab 100644 --- a/src/lib/elua/Elua.h +++ b/src/lib/elua/Elua.h @@ -104,9 +104,35 @@ extern "C" { #include <lualib.h> #include <lauxlib.h> +/** Opaque Elua state + * + * @ingroup Elua + */ typedef struct _Elua_State Elua_State; +/** + * @brief Initialize the Elua library. + * + * This initializes the Elua library for usage. It maintains an internal + * counter so that multiple calls will only increment/decrement correctly. + * + * @see elua_shutdown + * + * @ingroup Elua + */ EAPI int elua_init(void); + +/** + * @brief Shutdown the Elua library. + * + * Depending on the internal initialization counter, this either decrements + * or completely shuts down the Elua library. In any case, call this once for + * each init call. + * + * @see elua_init + * + * @ingroup Elua + */ EAPI int elua_shutdown(void); EAPI Elua_State *elua_state_new(const char *progname); |