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

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
+8 -10
View File
@@ -75,7 +75,7 @@ public:
* Creates a new Body at the specified position.
* @param world The world to create the Body in.
* @param x The position along the x-axis.
* @param x The position along the y-axis.
* @param y The position along the y-axis.
* @param type The type of body to create.
**/
Body *newBody(World *world, float x, float y, Body::Type type);
@@ -141,14 +141,12 @@ public:
EdgeShape *newEdgeShape(float x1, float y1, float x2, float y2);
/**
* Creates a new PolygonShape.
* @param ... A variable number of vertices.
* Creates a new PolygonShape from a variable number of vertices.
**/
int newPolygonShape(lua_State *L);
/**
* Creates a new ChainShape.
* @param ... A variable number of vertices.
* Creates a new ChainShape from a variable number of vertices.
**/
int newChainShape(lua_State *L);
@@ -272,13 +270,13 @@ public:
/**
* Sets the number of pixels in one meter.
* @param pixels The number of pixels in one meter. (1m ~= 3.3ft).
* @param scale The number of pixels in one meter. (1m ~= 3.3ft).
**/
static void setMeter(int meter);
static void setMeter(int scale);
/**
* Gets the number of pixels in one meter.
* @param pixels The number of pixels in one meter. (1m ~= 3.3ft).
* @return The number of pixels in one meter. (1m ~= 3.3ft).
**/
static int getMeter();
@@ -326,14 +324,14 @@ public:
/**
* Scales a b2AABB down according to the current meter in pixels.
* @param v The unscaled input AABB.
* @param aabb The unscaled input AABB.
* @return The scaled AABB.
**/
static b2AABB scaleDown(const b2AABB &aabb);
/**
* Scales a b2AABB up according to the current meter in pixels.
* @param v The unscaled input AABB.
* @param aabb The unscaled input AABB.
* @return The scaled AABB.
**/
static b2AABB scaleUp(const b2AABB &aabb);