Documentation for module 'NDK'

Former-commit-id: a6c2075cfbfd0eccf2b77def71c0d42684bed590 [formerly 36ece2bc6a148bde6cacf45084821d20edcd115e] [formerly 4a6988792ec026e65be6850c46dfe8ddda92a885 [formerly fd3f4f975de5c427f3adc98b220446fd255be396]]
Former-commit-id: c87fdc9483202842267c60eff3d619f0df2963bf [formerly ee35202f1b2df7ca20da5b6d8b13147f2b92c933]
Former-commit-id: dad5de1b00bb4413f7aa191ca06b7d43b659f32a

SDK/include/NDK/Application.inl

@@ -8,6 +8,12 @@
 
 namespace Ndk
 {
+	/*!
+	* \brief Constructs an Application object by default
+	*
+	* \remark Produces a NazaraAssert if there's more than one application instance currently running
+	*/
+
 	inline Application::Application() :
 	#ifndef NDK_SERVER
 	m_exitOnClosedWindows(true),
@@ -24,6 +30,10 @@ namespace Ndk
 		Sdk::Initialize();
 	}
 
+	/*!
+	* \brief Destructs the object
+	*/
+
 	inline Application::~Application()
 	{
 		m_worlds.clear();
@@ -31,13 +41,20 @@ namespace Ndk
 		m_windows.clear();
 		#endif
 
-		// Libération du SDK
+		// Free of SDK
 		Sdk::Uninitialize();
 
-		// Libération automatique des modules
+		// Automatic free of modules
 		s_application = nullptr;
 	}
 
+	/*!
+	* \brief Adds a window to the application
+	* \return A reference to the newly created windows
+	*
+	* \param args Arguments used to create the window
+	*/
+
 	#ifndef NDK_SERVER
 	template<typename T, typename... Args> 
 	T& Application::AddWindow(Args&&... args)
@@ -49,6 +66,13 @@ namespace Ndk
 	}
 	#endif
 
+	/*!
+	* \brief Adds a world to the application
+	* \return A reference to the newly created world
+	*
+	* \param args Arguments used to create the world
+	*/
+
 	template<typename... Args> 
 	World& Application::AddWorld(Args&&... args)
 	{
@@ -56,11 +80,22 @@ namespace Ndk
 		return m_worlds.back();
 	}
 
+	/*!
+	* \brief Gets the update time of the application
+	* \return Update rate
+	*/
+
 	inline float Application::GetUpdateTime() const
 	{
 		return m_updateTime;
 	}
 
+	/*!
+	* \brief Makes the application exit when there's no more open window
+	*
+	* \param exitOnClosedWindows Should exit be called when no more window is open
+	*/
+
 	#ifndef NDK_SERVER
 	inline void Application::MakeExitOnLastWindowClosed(bool exitOnClosedWindows)
 	{
@@ -68,11 +103,20 @@ namespace Ndk
 	}
 	#endif
 
+	/*!
+	* \brief Quits the application
+	*/
+
 	inline void Application::Quit()
 	{
 		m_shouldQuit = true;
 	}
 
+	/*!
+	* \brief Gets the singleton instance of the application
+	* \return Singleton application
+	*/
+
 	inline Application* Application::Instance()
 	{
 		return s_application;