Commits

Alex Szpakowski committed 0eac995

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

Comments (0)

Files changed (18)

src/common/Vector.h

 	/**
 	 * Gets a vector perpendicular to the Vector.
 	 * To get the true (normalized) normal, use v.getNormal(1.0f / v.getLength())
-	 * @param Scale factor to apply.
+	 * @param scale factor to apply.
 	 * @return A normal to the Vector.
 	 **/
 	Vector getNormal(float scale) const;
 
 	/**
 	 * Sets the x value of the Vector.
-	 * @param The x value of the Vector.
+	 * @param x The x value of the Vector.
 	 **/
 	void setX(float x);
 
 	/**
 	 * Sets the x value of the Vector.
-	 * @param The x value of the Vector.
+	 * @param y The x value of the Vector.
 	 **/
 	void setY(float y);
 

src/common/runtime.h

  * @param type The type bit.
  **/
 template <typename T>
-T *luax_totype(lua_State *L, int idx, const char *, love::bits)
+T *luax_totype(lua_State *L, int idx, const char * /* name */, love::bits /* type */)
 {
 	return (T *)(((Proxy *)lua_touserdata(L, idx))->data);
 }

src/modules/filesystem/physfs/File.h

 public:
 
 	/**
-	 * Constructs an File with the given source and filename.
-	 * @param source The source from which to load the file. (Archive or directory)
-	 * @param filename The relative filepath of the file to load from the source.
+	 * Constructs an File with the given ilename.
+	 * @param filename The relative filepath of the file to load.
 	 **/
 	File(const std::string &filename);
 

src/modules/graphics/opengl/Font.h

 {
 public:
 
-	/**
-	 * Default constructor.
-	 *
-	 * @param data The font data to construct from.
-	 **/
 	Font(love::font::Rasterizer *r, const Image::Filter &filter = Image::getDefaultFilter());
 
 	virtual ~Font();

src/modules/graphics/opengl/Graphics.h

 
 	/**
 	 * 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
 	 **/

src/modules/graphics/opengl/OpenGL.h

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

src/modules/graphics/opengl/ParticleSystem.h

 
 	/**
 	 * Returns the current insert mode.
-	 * @param mode The current insert mode.
 	 */
 	InsertMode getInsertMode() const;
 
 
 	/**
 	 * 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;
 
 
 	/**
 	 * 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;
 
 
 	/**
 	 * 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;
 
 
 	/**
 	 * 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;
 
 	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;
 
 
 	/**
 	 * 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;
 

src/modules/graphics/opengl/VertexBuffer.h

 	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;
 

src/modules/image/Image.h

 
 	/**
 	 * Creates empty ImageData with the given size.
-	 * @param The width of the ImageData.
-	 * @param The height of the ImageData.
+	 * @param width The width of the ImageData.
+	 * @param height The height of the ImageData.
 	 * @return The new ImageData.
 	 **/
 	virtual ImageData *newImageData(int width, int height) = 0;
 
 	/**
 	 * Creates empty ImageData with the given size.
-	 * @param The width of the ImageData.
-	 * @param The height of the ImageData.
-	 * @param The data to load into the ImageData.
-	 * @param Whether the new ImageData should take ownership of the data or
+	 * @param width The width of the ImageData.
+	 * @param height The height of the ImageData.
+	 * @param data The data to load into the ImageData.
+	 * @param own Whether the new ImageData should take ownership of the data or
 	 *        copy it.
 	 * @return The new ImageData.
 	 **/

src/modules/keyboard/Keyboard.h

 	virtual bool hasKeyRepeat() const = 0;
 
 	/**
-	 * Checks whether a certain key is down or not.
-	 * @param key A key identifier.
+	 * Checks whether certain keys are down or not.
+	 * @param keylist An array of key identifiers, terminated by KEY_MAX_ENUM.
 	 * @return boolean
 	 **/
 	virtual bool isDown(Key *keylist) const = 0;

src/modules/math/BezierCurve.h

 
 	/**
 	 * Scale the curve.
-	 * @param s Scale factor.
+	 * @param phi Scale factor.
 	 * @param center Scale center.
 	 */
 	void scale(double phi, const Vector &center);

src/modules/physics/box2d/Body.h

 
 	/**
 	 * 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);
 
 	 * 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);
 
 	 * 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);
 
 	 * 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);
 
 	 * 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);
 
 	 * 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);
 
 	 * 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);
 

src/modules/physics/box2d/CircleShape.h

 public:
 
 	/**
-	 * Create a new CircleShape from the parent body and a
-	 * Box2D CircleShape definition.
-	 * @param body The parent body.
-	 * @param def The CircleShape definition.
+	 * Create a new CircleShape from the a Box2D CircleShape definition.
+	 * @param c The CircleShape definition.
 	 **/
 	CircleShape(b2CircleShape *c, bool own = true);
 

src/modules/physics/box2d/Contact.h

 	 * Creates a new Contact by copying a Box2D contact
 	 * point. It does not store the pointer, but copy the
 	 * data pointed to.
-	 * @param point Pointer to the Box2D contact.
+	 * @param contact Pointer to the Box2D contact.
 	 **/
 	Contact(b2Contact *contact);
 

src/modules/physics/box2d/Physics.cpp

 	return 5;
 }
 
-void Physics::setMeter(int meter)
+void Physics::setMeter(int scale)
 {
-	if (meter < 1) throw love::Exception("Physics error: invalid meter");
-	Physics::meter = meter;
+	if (scale < 1) throw love::Exception("Physics error: invalid meter");
+	Physics::meter = scale;
 }
 
 int Physics::getMeter()

src/modules/physics/box2d/Physics.h

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

src/modules/physics/box2d/PolygonShape.h

 public:
 
 	/**
-	 * Create a new PolygonShape from the parent Body and
-	 * a Box2D polygon definition.
-	 * @param body The parent Body.
-	 * @param def The polygon definition.
+	 * Create a new PolygonShape from a Box2D polygon definition.
+	 * @param p The polygon definition.
 	 **/
 	PolygonShape(b2PolygonShape *p, bool own = true);
 

src/modules/sound/Sound.h

 
 	/**
 	 * Creates a new SoundData with the specified number of samples and format.
-	 * @param duration In seconds.
+	 * @param samples The number of samples.
 	 * @param sampleRate Number of samples per second.
 	 * @param bitDepth Bits per sample (8 or 16).
 	 * @param channels Either 1 for mono, or 2 for stereo.
 	 * specified file.
 	 * @param file The file with encoded sound data.
 	 * @param bufferSize The size of each decoded chunk.
-	 * @param sampleRate Samples per second, or quality of the audio. 44100 is a good value.
 	 * @return A Decoder object on success, or zero if no decoder could be found.
 	 **/
 	virtual Decoder *newDecoder(filesystem::FileData *file, int bufferSize) = 0;
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.