summaryrefslogtreecommitdiff
path: root/src/lib/elua
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-04-20 14:41:50 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-05-06 15:05:21 +0100
commitf16f21f37d926cc87b3ea8dcc03538e6f9aa4a7c (patch)
treea7ef6dbfc8da98688cb5b2197df2e656e40fda73 /src/lib/elua
parent81e3f753da5ab2edc3a0cb2ba7576dffbb0863ed (diff)
elua lib: add init/shutdown doc
Diffstat (limited to 'src/lib/elua')
-rw-r--r--src/lib/elua/Elua.h26
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" {
104#include <lualib.h> 104#include <lualib.h>
105#include <lauxlib.h> 105#include <lauxlib.h>
106 106
107/** Opaque Elua state
108 *
109 * @ingroup Elua
110 */
107typedef struct _Elua_State Elua_State; 111typedef struct _Elua_State Elua_State;
108 112
113/**
114 * @brief Initialize the Elua library.
115 *
116 * This initializes the Elua library for usage. It maintains an internal
117 * counter so that multiple calls will only increment/decrement correctly.
118 *
119 * @see elua_shutdown
120 *
121 * @ingroup Elua
122 */
109EAPI int elua_init(void); 123EAPI int elua_init(void);
124
125/**
126 * @brief Shutdown the Elua library.
127 *
128 * Depending on the internal initialization counter, this either decrements
129 * or completely shuts down the Elua library. In any case, call this once for
130 * each init call.
131 *
132 * @see elua_init
133 *
134 * @ingroup Elua
135 */
110EAPI int elua_shutdown(void); 136EAPI int elua_shutdown(void);
111 137
112EAPI Elua_State *elua_state_new(const char *progname); 138EAPI Elua_State *elua_state_new(const char *progname);