From 0593c2eab29e61692738dd8d88cfa88501803f0d Mon Sep 17 00:00:00 2001 From: Einar Johan Trøan Sømåen Date: Fri, 29 Aug 2014 03:26:48 +0200 Subject: GRAPHICS: Fix some Doxygen comments that seem wrong. --- graphics/VectorRenderer.h | 4 +--- graphics/conversion.h | 8 ++++---- graphics/fontman.h | 1 - graphics/surface.h | 5 ++--- graphics/transform_tools.h | 10 +++++----- 5 files changed, 12 insertions(+), 16 deletions(-) diff --git a/graphics/VectorRenderer.h b/graphics/VectorRenderer.h index 8e1c5e91e1..703da68182 100644 --- a/graphics/VectorRenderer.h +++ b/graphics/VectorRenderer.h @@ -182,7 +182,7 @@ public: * @param x Horizontal (X) coordinate for the top left corner of the triangle * @param y Vertical (Y) coordinate for the top left corner of the triangle * @param base Width of the base of the triangle - * @param h Height of the triangle + * @param height Height of the triangle * @param orient Orientation of the triangle. */ virtual void drawTriangle(int x, int y, int base, int height, TriangleOrientation orient) = 0; @@ -276,8 +276,6 @@ public: /** * Fills the active surface with the specified fg/bg color or the active gradient. * Defaults to using the active Foreground color for filling. - * - * @param mode Fill mode (bg, fg or gradient) used to fill the surface */ virtual void fillSurface() = 0; diff --git a/graphics/conversion.h b/graphics/conversion.h index 33d57f7a4f..8ca529acc0 100644 --- a/graphics/conversion.h +++ b/graphics/conversion.h @@ -48,10 +48,10 @@ inline static void RGB2YUV(byte r, byte g, byte b, byte &y, byte &u, byte &v) { /** * Blits a rectangle from one graphical format to another. * - * @param dstbuf the buffer which will recieve the converted graphics data - * @param srcbuf the buffer containing the original graphics data - * @param dstpitch width in bytes of one full line of the dest buffer - * @param srcpitch width in bytes of one full line of the source buffer + * @param dst the buffer which will recieve the converted graphics data + * @param src the buffer containing the original graphics data + * @param dstPitch width in bytes of one full line of the dest buffer + * @param srcPitch width in bytes of one full line of the source buffer * @param w the width of the graphics data * @param h the height of the graphics data * @param dstFmt the desired pixel format diff --git a/graphics/fontman.h b/graphics/fontman.h index b3de92f547..515b157e6a 100644 --- a/graphics/fontman.h +++ b/graphics/fontman.h @@ -75,7 +75,6 @@ public: * Associates a BDF font object with an 'usage'. This is useful for platforms * with a screen DPI much larger than a regular desktop workstation. * - * @param name the name of the font * @param font the font object * @return true on success, false on failure */ diff --git a/graphics/surface.h b/graphics/surface.h index d083449854..ad15944361 100644 --- a/graphics/surface.h +++ b/graphics/surface.h @@ -214,7 +214,7 @@ public: * of buffer must match the pixel format of the Surface. * * @param buffer The buffer containing the graphics data source - * @param pitch The pitch of the buffer (number of bytes in a scanline) + * @param srcPitch The pitch of the buffer (number of bytes in a scanline) * @param destX The x coordinate of the destination rectangle * @param destY The y coordinate of the destination rectangle * @param width The width of the destination rectangle @@ -228,8 +228,7 @@ public: * @param srcSurface The source of the bitmap data * @param destX The x coordinate of the destination rectangle * @param destY The y coordinate of the destination rectangle - * @param subRect The subRect of surface to be blitted - * @return + * @param subRect The subRect of surface to be blitted */ void copyRectToSurface(const Graphics::Surface &srcSurface, int destX, int destY, const Common::Rect subRect); diff --git a/graphics/transform_tools.h b/graphics/transform_tools.h index c618f7c35a..a51c8ee229 100644 --- a/graphics/transform_tools.h +++ b/graphics/transform_tools.h @@ -57,15 +57,15 @@ class TransformTools { public: /** * Basic transform (scale + rotate) for a single point + * @param point the point on which the transform is to be applied + * @param rotate the angle in degrees + * @param zoom zoom x,y in percent + * @param mirrorX flip along the vertical axis? + * @param mirrorY flip along the horizontal axis? */ static FloatPoint transformPoint(FloatPoint point, const float rotate, const Common::Point &zoom, const bool mirrorX = false, const bool mirrorY = false); /** - * @param &point the point on which the transform is to be applied - * @param rotate the angle in degrees - * @param &zoom zoom x,y in percent - * @param mirrorX flip along the vertical axis? - * @param mirrorY flip along the horizontal axis? * @return the smallest rect that can contain the transformed sprite * and, as a side-effect, "newHotspot" will tell you where the hotspot will * have ended up in the new rect, for centering. -- cgit v1.2.3