Documentation for module 'NDK'

Former-commit-id: 7d8a51d8ad14bfb16a76b8d77c92c776bfb694ab [formerly 1dac8450f2eddf175b3eb2b6675621ea0b2a0df7] [formerly bb4300770d267df0eed5c509ec748c6866f36376 [formerly d15a100319ffc8805c7f93c9bcd936e204dad40b]]
Former-commit-id: 83a4715ed2a3220b7ef4718401d50ce584d275fc [formerly a941a150d510a51daed4322723795d90b6d56724]
Former-commit-id: f46308abb0bc577d73447f6a574ec091a50a9cca

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;