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