Documentation for module 'NDK'

Former-commit-id: 63e1cac538c577a1f1aafa71fa7eef69a6d4daab [formerly b2d8769fd02a0e7d9c476d4ad7be1988a1fd6789] [formerly 636b5cb79bcb8da44d9aa45ba1023565bcf29f0d [formerly a2361ec2b8679d4d4ba096e543b5d4b91825dd62]]
Former-commit-id: d402d35477f9db0135c553d55c401939426bf62d [formerly 607336ea0f42731e4604f3a8c2df06f3aecfc401]
Former-commit-id: 69e23cd6c06723486de5e4641ce810012dac66da

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();