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