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