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/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;