elua lib: add state_from_lua_state_get doc

1 files changed, 14 insertions, 0 deletions

diff --git a/src/lib/elua/Elua.h b/src/lib/elua/Elua.h
index c88d20997a..e764750c1c 100644
--- a/src/lib/elua/Elua.h
+++ b/src/lib/elua/Elua.h
@@ -150,6 +150,20 @@ EAPI int elua_shutdown(void);
  * @ingroup Elua
  */
 EAPI Elua_State *elua_state_new(const char *progname);
+
+/**
+ * @brief Retrieve an Elua state from a Lua state.
+ *
+ * This doesn't create a new Elua state. Instead it just retrieves an existing
+ * Elua state given a Lua state. If no Elua state could be found (for example
+ * when the Lua state was created independently of Elua), this function returns
+ * NULL.
+ *
+ * @param[in] L The Lua state.
+ * @return An Elua state or NULL.
+ *
+ * @ingroup Elua
+ */
 EAPI Elua_State *elua_state_from_lua_state_get(lua_State *L);
 
 EAPI void elua_state_free(Elua_State *es);