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

@@ -6,6 +6,14 @@
 
 namespace Ndk
 {
+	/*!
+	* \brief Binds a component to a name
+	*
+	* \param name Name used to retrieve the component
+	*
+	* \remark Produces a NazaraAssert if name is empty
+	*/
+
 	template<typename T>
 	void LuaBinding::BindComponent(const Nz::String& name)
 	{
@@ -24,6 +32,16 @@ namespace Ndk
 		m_componentBindingByName[name] = T::componentIndex;
 	}
 
+	/*!
+	* \brief Adds a component to an entity
+	* \return 1 in case of success
+	*
+	* \param instance Lua instance that will interact with the component
+	* \param handle Entity which component will be added to
+	*
+	* \remark T must be a subtype of BaseComponent
+	*/
+
 	template<typename T>
 	int AddComponentOfType(Nz::LuaInstance& lua, EntityHandle& handle)
 	{
@@ -34,6 +52,16 @@ namespace Ndk
 		return 1;
 	}
 
+	/*!
+	* \brief Pushes a component
+	* \return 1 in case of success
+	*
+	* \param instance Lua instance that will interact with the component
+	* \param component Component that will be pushed
+	*
+	* \remark T must be a subtype of BaseComponent
+	*/
+
 	template<typename T>
 	int PushComponentOfType(Nz::LuaInstance& lua, BaseComponent& component)
 	{