Documentation for module 'NDK'

Former-commit-id: 63e1cac538c577a1f1aafa71fa7eef69a6d4daab [formerly b2d8769fd02a0e7d9c476d4ad7be1988a1fd6789] [formerly 636b5cb79bcb8da44d9aa45ba1023565bcf29f0d [formerly a2361ec2b8679d4d4ba096e543b5d4b91825dd62]]
Former-commit-id: d402d35477f9db0135c553d55c401939426bf62d [formerly 607336ea0f42731e4604f3a8c2df06f3aecfc401]
Former-commit-id: 69e23cd6c06723486de5e4641ce810012dac66da

SDK/src/NDK/LuaAPI.cpp

@@ -5,12 +5,29 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::LuaAPI
+	* \brief NDK class that represents the api used for Lua
+	*/
+
+	/*!
+	* \brief Initializes the LuaAPI module
+	* \return true if initialization is successful
+	*/
+
 	bool LuaAPI::Initialize()
 	{
 		s_binding = new LuaBinding;
 		return true;
 	}
 
+	/*!
+	* \brief Registers the classes that will be used by the Lua instance
+	*
+	* \param instance Lua instance that will interact with the engine & SDK
+	*/
+
 	void LuaAPI::RegisterClasses(Nz::LuaInstance& instance)
 	{
 		if (!s_binding && !Initialize())
@@ -22,6 +39,10 @@ namespace Ndk
 		s_binding->RegisterClasses(instance);
 	}
 
+	/*!
+	* \brief Uninitializes the LuaAPI module
+	*/
+
 	void LuaAPI::Uninitialize()
 	{
 		delete s_binding;