LOVE/love
1
0
Fork 0
mirror of https://github.com/love2d/love.git synced 2026-08-16 00:02:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fixed some internal documentation (thanks to clang's -Wdocumentation)

Browse Source
This commit is contained in:
Alex Szpakowski
2013-09-23 21:52:28 -03:00
parent 06f2ec8e31
commit 8d5ddb9e34
18 changed files with 71 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/modules/physics/box2d/Body.h
+20 -18
View File
@@ -91,29 +91,31 @@ public:
/**
* Gets the current position of the Body.
* @returns The current position.
* @param[out] x_o The x-component of the position.
* @param[out] y_o The y-component of the position.
**/
void getPosition(float &x_o, float &y_o);
/**
* Gets the velocity in the current center of mass.
* @returns The velocity in the current center of mass.
* @param[out] x_o The x-component of the velocity.
* @param[out] y_o The y-component of the velocity.
**/
void getLinearVelocity(float &x_o, float &y_o);
/**
* The current center of mass for the Body in world
* coordinates.
* @returns The x-component of the point.
* @returns The y-component of the point.
* @param[out] x_o The x-component of the center of mass.
* @param[out] y_o The y-component of the center of mass.
**/
void getWorldCenter(float &x_o, float &y_o);
/**
* The current center of mass for the Body in local
* coordinates.
* @returns The x-component of the point.
* @returns The y-component of the point.
* @param[out] x_o The x-component of the center of mass.
* @param[out] y_o The y-component of the center of mass.
**/
void getLocalCenter(float &x_o, float &y_o);
@@ -269,8 +271,8 @@ public:
* to world coordinates.
* @param x The x-coordinate of the local point.
* @param y The y-coordinate of the local point.
* @returns The x-coordinate of the point in world coordinates.
* @returns The y-coordinate of the point in world coordinates.
* @param[out] x_o The x-coordinate of the point in world coordinates.
* @param[out] y_o The y-coordinate of the point in world coordinates.
**/
void getWorldPoint(float x, float y, float &x_o, float &y_o);
@@ -279,8 +281,8 @@ public:
* to world coordinates.
* @param x The x-coordinate of the local vector.
* @param y The y-coordinate of the local vector.
* @returns The x-coordinate of the vector in world coordinates.
* @returns The y-coordinate of the vector in world coordinates.
* @param[out] x_o The x-coordinate of the vector in world coordinates.
* @param[out] y_o The y-coordinate of the vector in world coordinates.
**/
void getWorldVector(float x, float y, float &x_o, float &y_o);
@@ -295,8 +297,8 @@ public:
* to local coordinates.
* @param x The x-coordinate of the world point.
* @param y The y-coordinate of the world point.
* @returns The x-coordinate of the point in local coordinates.
* @returns The y-coordinate of the point in local coordinates.
* @param[out] x_o The x-coordinate of the point in local coordinates.
* @param[out] y_o The y-coordinate of the point in local coordinates.
**/
void getLocalPoint(float x, float y, float &x_o, float &y_o);
@@ -305,8 +307,8 @@ public:
* to local coordinates.
* @param x The x-coordinate of the world vector.
* @param y The y-coordinate of the world vector.
* @returns The x-coordinate of the vector in local coordinates.
* @returns The y-coordinate of the vector in local coordinates.
* @param[out] x_o The x-coordinate of the vector in local coordinates.
* @param[out] y_o The y-coordinate of the vector in local coordinates.
**/
void getLocalVector(float x, float y, float &x_o, float &y_o);
@@ -314,8 +316,8 @@ public:
* Gets the velocity on the Body for the given world point.
* @param x The x-coordinate of the world point.
* @param y The y-coordinate of the world point.
* @returns The x-component of the velocity vector.
* @returns The y-component of the velocity vector.
* @param[out] x_o The x-component of the velocity vector.
* @param[out] y_o The y-component of the velocity vector.
**/
void getLinearVelocityFromWorldPoint(float x, float y, float &x_o, float &y_o);
@@ -323,8 +325,8 @@ public:
* Gets the velocity on the Body for the given local point.
* @param x The x-coordinate of the local point.
* @param y The y-coordinate of the local point.
* @returns The x-component of the velocity vector.
* @returns The y-component of the velocity vector.
* @param[out] x_o The x-component of the velocity vector.
* @param[out] y_o The y-component of the velocity vector.
**/
void getLinearVelocityFromLocalPoint(float x, float y, float &x_o, float &y_o);