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

@@ -8,6 +8,21 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::StateMachine
+	* \brief NDK class that represents a state machine, to represent the multiple states of your program
+	*/
+
+	/*!
+	* \brief Constructs a StateMachine object with an original state
+	*
+	* \param originalState State which is the entry point of the application
+	*
+	* \remark Calls "Enter" on the state
+	* \remark Produces a NazaraAssert if nullptr is given
+	*/
+
 	inline StateMachine::StateMachine(std::shared_ptr<State> originalState) :
 	m_currentState(std::move(originalState))
 	{
@@ -15,22 +30,45 @@ namespace Ndk
 		m_currentState->Enter(*this);
 	}
 
+	/*!
+	* \brief Destructs the object
+	*
+	* \remark Calls "Leave" on the state
+	*/
+
 	inline StateMachine::~StateMachine()
 	{
 		m_currentState->Leave(*this);
 	}
 
+	/*!
+	* \brief Changes the current state of the machine
+	*
+	* \param state Next state to represent
+	*/
 
 	inline void StateMachine::ChangeState(std::shared_ptr<State> state)
 	{
 		m_nextState = std::move(state);
 	}
 
+	/*!
+	* \brief Gets the current state of the machine
+	* \return A constant reference to the state
+	*/
+
 	inline const std::shared_ptr<State>& StateMachine::GetCurrentState() const
 	{
 		return m_currentState;
 	}
 
+	/*!
+	* \brief Updates the state 
+	* \return True if update is successful
+	*
+	* \param elapsedTime Delta time used for the update
+	*/
+
 	inline bool StateMachine::Update(float elapsedTime)
 	{
 		if (m_nextState)