WINTERMUTE: Correct some doxygen-comments in TransparentSurface.

2 files changed, 15 insertions, 23 deletions

diff --git a/engines/wintermute/graphics/transparent_surface.cpp b/engines/wintermute/graphics/transparent_surface.cpp
index 43deb62db6..053acf29e9 100644
--- a/engines/wintermute/graphics/transparent_surface.cpp
+++ b/engines/wintermute/graphics/transparent_surface.cpp
@@ -76,7 +76,6 @@ public:
  * @param *outa, *outr, *outg, *outb pointer to the output pixel.
  * @param *outa, *outr, *outg, *outb pointer to the colormod components.
  */
-
 void BlenderAdditive::blendPixel(byte ina, byte inr, byte ing, byte inb, byte *outa, byte *outr, byte *outg, byte *outb, byte *ca, byte *cr, byte *cg, byte *cb) {
 	if (*ca != 255) {
 		ina = (ina) * (*ca) >> 8;
@@ -108,7 +107,6 @@ void BlenderAdditive::blendPixel(byte ina, byte inr, byte ing, byte inb, byte *o
  * @param *outa, *outr, *outg, *outb pointer to the output pixel.
  * @param *outa, *outr, *outg, *outb pointer to the colormod components.
  */
-
 void BlenderSubtractive::blendPixel(byte ina, byte inr, byte ing, byte inb, byte *outa, byte *outr, byte *outg, byte *outb, byte *ca, byte *cr, byte *cg, byte *cb) {
 	//if (*ca != 255) {
 	//	ina = ina * (*ca) >> 8;
@@ -234,7 +232,6 @@ void BlenderNormal::blendPixel(byte ina, byte inr, byte ing, byte inb, byte *out
  * @param ina, inr, ing, inb: the input pixel, split into its components.
  * @param *outa, *outr, *outg, *outb pointer to the output pixel.
  */
-
 void BlenderSubtractive::blendPixel(byte ina, byte inr, byte ing, byte inb, byte *outa, byte *outr, byte *outg, byte *outb) {
 
 	if (ina == 0) {
@@ -259,7 +256,6 @@ void BlenderSubtractive::blendPixel(byte ina, byte inr, byte ing, byte inb, byte
  * @param ina, inr, ing, inb: the input pixel, split into its components.
  * @param *outa, *outr, *outg, *outb pointer to the output pixel.
  */
-
 void BlenderAdditive::blendPixel(byte ina, byte inr, byte ing, byte inb, byte *outa, byte *outr, byte *outg, byte *outb) {
 
 	if (ina == 0) {
@@ -297,10 +293,11 @@ TransparentSurface::TransparentSurface(const Surface &surf, bool copyData) : Sur
 	}
 }
 
-void doBlitOpaqueFast(byte *ino, byte *outo, uint32 width, uint32 height, uint32 pitch, int32 inStep, int32 inoStep) {
 /**
  * Optimized version of doBlit to be used w/opaque blitting (no alpha).
  */
+void doBlitOpaqueFast(byte *ino, byte *outo, uint32 width, uint32 height, uint32 pitch, int32 inStep, int32 inoStep) {
+
 	byte *in;
 	byte *out;
 
@@ -320,7 +317,6 @@ void doBlitOpaqueFast(byte *ino, byte *outo, uint32 width, uint32 height, uint32
 /**
  * Optimized version of doBlit to be used w/binary blitting (blit or no-blit, no blending).
  */
-
 void doBlitBinaryFast(byte *ino, byte *outo, uint32 width, uint32 height, uint32 pitch, int32 inStep, int32 inoStep) {
 
 	byte *in;
@@ -350,8 +346,8 @@ void doBlitBinaryFast(byte *ino, byte *outo, uint32 width, uint32 height, uint32
  * What we have here is a template method that calls blendPixel() from a different
  * class - the one we call it with - thus performing a different type of blending.
  *
- * @param *ino a pointer to the input surface
- * @param *outo a pointer to the output surface
+ * @param ino a pointer to the input surface
+ * @param outo a pointer to the output surface
  * @param width width of the input surface
  * @param height height of the input surface
  * @param pitch pitch of the output surface - that is, width in bytes of every row, usually bpp * width of the TARGET surface (the area we are blitting to might be smaller, do the math)
@@ -924,8 +920,4 @@ TransparentSurface *TransparentSurface::scale(uint16 newWidth, uint16 newHeight)
 
 }
 
-
-
-
-
 } // End of namespace Wintermute
diff --git a/engines/wintermute/graphics/transparent_surface.h b/engines/wintermute/graphics/transparent_surface.h
index b887c05fa8..1f3827d1a9 100644
--- a/engines/wintermute/graphics/transparent_surface.h
+++ b/engines/wintermute/graphics/transparent_surface.h
@@ -99,32 +99,31 @@ struct TransparentSurface : public Graphics::Surface {
 
 	/**
 	 @brief renders the surface to another surface
-	 @param pDest a pointer to the target image. In most cases this is the framebuffer.
-	 @param PosX the position on the X-axis in the target image in pixels where the image is supposed to be rendered.<br>
+	 @param target a pointer to the target surface. In most cases this is the framebuffer.
+	 @param posX the position on the X-axis in the target image in pixels where the image is supposed to be rendered.<br>
 	 The default value is 0.
-	 @param PosY the position on the Y-axis in the target image in pixels where the image is supposed to be rendered.<br>
+	 @param posY the position on the Y-axis in the target image in pixels where the image is supposed to be rendered.<br>
 	 The default value is 0.
-	 @param Flipping how the the image should be flipped.<br>
+	 @param flipping how the the image should be flipped.<br>
 	 The default value is BS_Image::FLIP_NONE (no flipping)
-	 @param pSrcPartRect Pointer on Common::Rect which specifies the section to be rendered. If the whole image has to be rendered the Pointer is NULL.<br>
+	 @param pPartRect Pointer on Common::Rect which specifies the section to be rendered. If the whole image has to be rendered the Pointer is NULL.<br>
 	 This referes to the unflipped and unscaled image.<br>
 	 The default value is NULL.
-	 @param Color an ARGB color value, which determines the parameters for the color modulation und alpha blending.<br>
+	 @param color an ARGB color value, which determines the parameters for the color modulation und alpha blending.<br>
 	 The alpha component of the color determines the alpha blending parameter (0 = no covering, 255 = full covering).<br>
 	 The color components determines the color for color modulation.<br>
 	 The default value is BS_ARGB(255, 255, 255, 255) (full covering, no color modulation).
 	 The macros BS_RGB and BS_ARGB can be used for the creation of the color value.
-	 @param Width the output width of the screen section.
+	 @param width the output width of the screen section.
 	 The images will be scaled if the output width of the screen section differs from the image section.<br>
 	 The value -1 determines that the image should not be scaled.<br>
 	 The default value is -1.
-	 @param Width the output height of the screen section.
+	 @param height the output height of the screen section.
 	 The images will be scaled if the output width of the screen section differs from the image section.<br>
 	 The value -1 determines that the image should not be scaled.<br>
 	 The default value is -1.
 	 @return returns false if the rendering failed.
 	 */
-
 	Common::Rect blit(Graphics::Surface &target, int posX = 0, int posY = 0,
 	                  int flipping = FLIP_NONE,
 	                  Common::Rect *pPartRect = nullptr,
@@ -137,8 +136,9 @@ struct TransparentSurface : public Graphics::Surface {
 	 * @brief Scale function; this returns a transformed version of this surface after rotation and
 	 * scaling. Please do not use this if angle != 0, use rotoscale.
 	 *
-	 * @param transform a TransformStruct wrapping the required info. @see TransformStruct
-	 * 
+	 * @param newWidth the resulting width.
+	 * @param newHeight the resulting height. 
+	 * @see TransformStruct
 	 */
 	TransparentSurface *scale(uint16 newWidth, uint16 newHeight) const;