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/Console.inl

@@ -7,41 +7,81 @@
 
 namespace Ndk
 {
+	/*!
+	* \brief Gets the character size
+	* \return Height of the character
+	*/
+
 	inline unsigned int Console::GetCharacterSize() const
 	{
 		return m_characterSize;
 	}
 
+	/*!
+	* \brief Gets the entity representing the history of the console
+	* \return History of the console
+	*/
+
 	inline const EntityHandle& Console::GetHistory() const
 	{
 		return m_history;
 	}
 
+	/*!
+	* \brief Gets the entity representing the background of the console's history
+	* \return Background history of the console
+	*/
+
 	inline const EntityHandle& Console::GetHistoryBackground() const
 	{
 		return m_historyBackground;
 	}
 
+	/*!
+	* \brief Gets the entity representing the input of the console
+	* \return Input of the console
+	*/
+
 	inline const EntityHandle& Console::GetInput() const
 	{
 		return m_input;
 	}
 
+	/*!
+	* \brief Gets the entity representing the background of the console's input
+	* \return Background input of the console
+	*/
+
 	inline const EntityHandle& Console::GetInputBackground() const
 	{
 		return m_inputBackground;
 	}
 
+	/*!
+	* \brief Gets the size of the console
+	* \return Size (Width, Height) of the console
+	*/
+
 	inline const Nz::Vector2f& Console::GetSize() const
 	{
 		return m_size;
 	}
 
+	/*!
+	* \brief Gets the font used by the console
+	* \return A reference to the font currenty used
+	*/
+
 	inline const Nz::FontRef& Console::GetTextFont() const
 	{
 		return m_defaultFont;
 	}
 
+	/*!
+	* \brief Checks whether the console is visible
+	* \return true If it is the case
+	*/
+
 	inline bool Console::IsVisible() const
 	{
 		return m_opened;