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/Components/CollisionComponent.inl

@@ -9,23 +9,47 @@
 
 namespace Ndk
 {
+	/*!
+	* \brief Constructs a CollisionComponent object with a geometry
+	*
+	* \param geom Reference to a geometry symbolizing the entity
+	*/
+
 	inline CollisionComponent::CollisionComponent(Nz::PhysGeomRef geom) :
 	m_geom(std::move(geom)),
 	m_bodyUpdated(false)
 	{
 	}
 
+	/*!
+	* \brief Constructs a CollisionComponent object by copy semantic
+	*
+	* \param collision CollisionComponent to copy
+	*/
+
 	inline CollisionComponent::CollisionComponent(const CollisionComponent& collision) :
 	m_geom(collision.m_geom),
 	m_bodyUpdated(false)
 	{
 	}
 
+	/*!
+	* \brief Gets the geometry representing the entity
+	* \return A constant reference to the physics geometry
+	*/
+
 	inline const Nz::PhysGeomRef& CollisionComponent::GetGeom() const
 	{
 		return m_geom;
 	}
 
+	/*!
+	* \brief Assigns the geometry to this component
+	* \return A reference to this
+	*
+	* \param geom Reference to a geometry symbolizing the entity
+	*/
+
 	inline CollisionComponent& CollisionComponent::operator=(Nz::PhysGeomRef geom)
 	{
 		SetGeom(geom);
@@ -33,6 +57,11 @@ namespace Ndk
 		return *this;
 	}
 
+	/*!
+	* \brief Gets the static body used by the entity
+	* \return A pointer to the entity
+	*/
+
 	inline Nz::PhysObject* CollisionComponent::GetStaticBody()
 	{
 		return m_staticBody.get();