From bbd9182f7f86753fd55ee975561d67cb2d85c6a8 Mon Sep 17 00:00:00 2001 From: Daniel Chappuis Date: Tue, 16 Jun 2020 23:17:41 +0200 Subject: [PATCH] Improve code documentation inside RigidBody class --- src/body/RigidBody.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/body/RigidBody.cpp b/src/body/RigidBody.cpp index d5a07888..be893ff4 100644 --- a/src/body/RigidBody.cpp +++ b/src/body/RigidBody.cpp @@ -139,7 +139,7 @@ decimal RigidBody::getMass() const { /// reset to zero at the end of each call of the PhyscisWorld::update() method. /// You can only apply a force to a dynamic body otherwise, this method will do nothing. /** - * @param force The force to apply on the body (in Newtons) + * @param force The force (in world-space) to apply on the body (in Newtons) * @param point The point where the force is applied (in local-space coordinates) */ void RigidBody::applyForceAtLocalPosition(const Vector3& force, const Vector3& point) { @@ -171,7 +171,7 @@ void RigidBody::applyForceAtLocalPosition(const Vector3& force, const Vector3& p /// reset to zero at the end of each call of the PhyscisWorld::update() method. /// You can only apply a force to a dynamic body otherwise, this method will do nothing. /** - * @param force The force to apply on the body (in Newtons) + * @param force The force (in world-space) to apply on the body (in Newtons) * @param point The point where the force is applied (in world-space coordinates) */ void RigidBody::applyForceAtWorldPosition(const Vector3& force, const Vector3& point) { @@ -228,7 +228,7 @@ void RigidBody::setLocalInertiaTensor(const Vector3& inertiaTensorLocal) { /// reset to zero at the end of each call of the PhyscisWorld::update() method. /// You can only apply a force to a dynamic body otherwise, this method will do nothing. /** - * @param force The external force to apply on the center of mass of the body (in Newtons) + * @param force The external force (in world-space) to apply on the center of mass of the body (in Newtons) */ void RigidBody::applyForceToCenterOfMass(const Vector3& force) {