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
-5
View File
@@ -44,11 +44,6 @@ class Font : public Object, public Volatile
{
public:
/**
* Default constructor.
*
* @param data The font data to construct from.
**/
Font(love::font::Rasterizer *r, const Image::Filter &filter = Image::getDefaultFilter());
virtual ~Font();
+1 -1
View File
@@ -430,7 +430,7 @@ public:
/**
* Draws a polygon with an arbitrary number of vertices.
* @param type The type of drawing (line/filled).
* @param mode The type of drawing (line/filled).
* @param coords Vertex components (x1, y1, x2, y2, etc.)
* @param count Coord array size
**/
+1 -1
View File
@@ -137,7 +137,7 @@ public:
* Helper for binding a texture to a specific texture unit.
*
* @param textureunit Index in the range of [0, maxtextureunits-1]
* @param resoreprev Restore previously bound texture unit when done.
* @param restoreprev Restore previously bound texture unit when done.
**/
void bindTextureToUnit(GLuint texture, int textureunit, bool restoreprev);
+15 -16
View File
@@ -116,7 +116,6 @@ public:
/**
* Returns the current insert mode.
* @param mode The current insert mode.
*/
InsertMode getInsertMode() const;
@@ -144,15 +143,15 @@ public:
/**
* Sets the life range of the particles.
* @param lifeMin The minimum life.
* @param lifeMax The maximum life (if 0, then becomes the same as minimum life).
* @param min The minimum life.
* @param max The maximum life (if 0, then becomes the same as minimum life).
**/
void setParticleLifetime(float min, float max = 0);
/**
* Gets the lifetime of a particle.
* @param[out] min
* @param[out] max
* @param[out] min The minimum life.
* @param[out] max The maximum life.
**/
void getParticleLifetime(float *min, float *max) const;
@@ -229,8 +228,8 @@ public:
/**
* Gets the speed of the particles.
* @param[out] min
* @param[out] max
* @param[out] min The minimum speed.
* @param[out] max The maximum speed.
**/
void getSpeed(float *min, float *max) const;
@@ -272,8 +271,8 @@ public:
/**
* Gets the radial acceleration.
* @param[out] min
* @param[out] max
* @param[out] min The minimum amount of radial acceleration.
* @param[out] max The maximum amount of radial acceleration.
**/
void getRadialAcceleration(float *min, float *max) const;
@@ -292,8 +291,8 @@ public:
/**
* Gets the tangential acceleration.
* @param[out] min
* @param[out] max
* @param[out] min The minimum tangential acceleration.
* @param[out] max The maximum tangential acceleration.
**/
void getTangentialAcceleration(float *min, float *max) const;
@@ -339,9 +338,9 @@ public:
void setRotation(float min, float max);
/**
* Gets the initial amount of rotation of a particle.
* @param[out] min
* @param[out] max
* Gets the initial amount of rotation of a particle, in radians.
* @param[out] min The minimum initial rotation.
* @param[out] max The maximum initial rotation.
**/
void getRotation(float *min, float *max) const;
@@ -360,8 +359,8 @@ public:
/**
* Gets the amount of spin of a particle during its lifetime.
* @param[out] start
* @param[out] end
* @param[out] start The initial spin, in radians / s.
* @param[out] end The final spin, in radians / s.
**/
void getSpin(float *start, float *end) const;
+2 -4
View File
@@ -132,10 +132,8 @@ public:
virtual void unmap() = 0;
/**
* Bind the VertexBuffer to the specified target.
* (GL_ARRAY_BUFFER, GL_ELEMENT_ARRAY_BUFFER).
*
* @param target GL_ARRAY_BUFFER or GL_ELEMENT_ARRAY_BUFFER.
* Bind the VertexBuffer to its specified target.
* (GL_ARRAY_BUFFER, GL_ELEMENT_ARRAY_BUFFER, etc).
*/
virtual void bind() = 0;