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

@@ -6,7 +6,15 @@
 
 namespace Ndk
 {
-	///TODO: constexpr avec le C++14
+	/*!
+	* \ingroup NDK
+	* \brief Builds a component id based on a name
+	* \return Identifier for the component
+	*
+	* \param name Name to generate id from
+	*/
+
+	///TODO: constexpr with the C++14
 	template<unsigned int N>
 	ComponentId BuildComponentId(const char (&name)[N])
 	{
@@ -19,18 +27,38 @@ namespace Ndk
 		return componentId;
 	}
 
+	/*!
+	* \ingroup NDK
+	* \brief Gets the component id of a component
+	* \return Identifier for the component
+	*/
+
 	template<typename ComponentType>
 	ComponentIndex GetComponentIndex()
 	{
 		return ComponentType::componentIndex;
 	}
 
+	/*!
+	* \ingroup NDK
+	* \brief Gets the system id of a system
+	* \return Identifier for the system
+	*/
+
 	template<typename SystemType>
 	SystemIndex GetSystemIndex()
 	{
 		return SystemType::systemIndex;
 	}
 
+	/*!
+	* \ingroup NDK
+	* \brief Initializes the a component
+	* \return Identifier for the component
+	*
+	* \param name Name to generate id from
+	*/
+
 	template<typename ComponentType, unsigned int N>
 	ComponentIndex InitializeComponent(const char (&name)[N])
 	{
@@ -38,6 +66,12 @@ namespace Ndk
 		return ComponentType::componentIndex;
 	}
 
+	/*!
+	* \ingroup NDK
+	* \brief Initializes the a system
+	* \return Identifier for the system
+	*/
+
 	template<typename SystemType>
 	SystemIndex InitializeSystem()
 	{
@@ -45,12 +79,26 @@ namespace Ndk
 		return SystemType::systemIndex;
 	}
 
+	/*!
+	* \brief Checks whether the parameter is a component
+	* \return true If it is the case
+	*
+	* \param component Component to check
+	*/
+
 	template<typename ComponentType, typename C>
 	bool IsComponent(C& component)
 	{
 		return component.GetIndex() == GetComponentIndex<ComponentType>();
 	}
 
+	/*!
+	* \brief Checks whether the parameter is a system
+	* \return true If it is the case
+	*
+	* \param system System to check
+	*/
+
 	template<typename SystemType, typename S>
 	bool IsSystem(S& system)
 	{