[Scummvm-cvs-logs] SF.net SVN: scummvm:[34781] scummvm/trunk/graphics

[fingolfin at users.sourceforge.net]

Revision: 34781
          http://scummvm.svn.sourceforge.net/scummvm/?rev=34781&view=rev
Author:   fingolfin
Date:     2008-10-12 21:56:03 +0000 (Sun, 12 Oct 2008)

Log Message:
-----------
Fix some in-line doxygen comments to document the correct member(s); also fixed some typos

Modified Paths:
--------------
    scummvm/trunk/graphics/VectorRenderer.h
    scummvm/trunk/graphics/VectorRendererSpec.h

Modified: scummvm/trunk/graphics/VectorRenderer.h
===================================================================
--- scummvm/trunk/graphics/VectorRenderer.h	2008-10-12 21:51:52 UTC (rev 34780)
+++ scummvm/trunk/graphics/VectorRenderer.h	2008-10-12 21:56:03 UTC (rev 34781)
@@ -38,18 +38,18 @@
 class VectorRenderer;
 
 struct DrawStep {
-	struct { 
+	struct Color { 
 		uint8 r, g, b;
 		bool set;
-	}	
-	fgColor, /** Foreground color */
-	bgColor, /** backgroudn color */
-	gradColor1, /** gradient start*/
-	gradColor2, /** gradient end */
-	bevelColor;
+	};
+	Color fgColor; /**< Foreground color */
+	Color bgColor; /**< background color */
+	Color gradColor1; /**< gradient start*/
+	Color gradColor2; /**< gradient end */
+	Color bevelColor;
 
 	bool autoWidth, autoHeight;
-	int16 x, y, w, h; /** width, height and position, if not measured automatically.
+	int16 x, y, w, h; /**< width, height and position, if not measured automatically.
 	 					  negative values mean counting from the opposite direction */
 	
 	enum VectorAlignment {
@@ -61,12 +61,12 @@
 		kVectorAlignCenter
 	} xAlign, yAlign;
 
-	uint8 shadow, stroke, factor, radius, bevel; /** Misc options... */
+	uint8 shadow, stroke, factor, radius, bevel; /**< Misc options... */
 
-	uint8 fillMode; /** active fill mode */
-	uint32 extraData; /** Generic parameter for extra options (orientation/bevel) */
+	uint8 fillMode; /**< active fill mode */
+	uint32 extraData; /**< Generic parameter for extra options (orientation/bevel) */
 
-	uint32 scale; /** scale of all the coordinates in FIXED POINT with 16 bits mantissa */
+	uint32 scale; /**< scale of all the coordinates in FIXED POINT with 16 bits mantissa */
 
 	void (VectorRenderer::*drawingCall)(const Common::Rect &, const DrawStep &); /** Pointer to drawing function */
 	Graphics::Surface *blitSrc;
@@ -322,7 +322,7 @@
 	 * Sets the stroke width. All shapes drawn with a stroke will
 	 * have that width. Pass 0 to disable shape stroking.
 	 *
-	 * @param width Witdh of the stroke in pixels.
+	 * @param width Width of the stroke in pixels.
 	 */
 	virtual void setStrokeWidth(int width) {
 		_strokeWidth = width;
@@ -504,7 +504,7 @@
 	/**
 	 * Applies a convolution matrix on the given surface area.
 	 * Call applyConvolutionMatrix() instead if you want to use
-	 * the embeded matrixes (blur/sharpen masks, bevels, etc).
+	 * the embedded matrixes (blur/sharpen masks, bevels, etc).
 	 *
 	 * @param area Area in which the convolution matrix will be applied.
 	 * @param filter Convolution matrix (3X3)
@@ -534,22 +534,22 @@
 	virtual void applyScreenShading(GUI::Theme::ShadingStyle) = 0;
 
 protected:
-	Surface *_activeSurface; /** Pointer to the surface currently being drawn */
+	Surface *_activeSurface; /**< Pointer to the surface currently being drawn */
 
-	FillMode _fillMode; /** Defines in which way (if any) are filled the drawn shapes */
+	FillMode _fillMode; /**< Defines in which way (if any) are filled the drawn shapes */
 	
-	int _shadowOffset; /** offset for drawn shadows */
-	int _bevel; /** amount of fake bevel */
-	bool _disableShadows; /** Disables temporarily shadow drawing for overlayed images. */
-	int _strokeWidth; /** Width of the stroke of all drawn shapes */
-	uint32 _dynamicData; /** Dynamic data from the GUI Theme that modifies the drawing of the current shape */
+	int _shadowOffset; /**< offset for drawn shadows */
+	int _bevel; /**< amount of fake bevel */
+	bool _disableShadows; /**< Disables temporarily shadow drawing for overlayed images. */
+	int _strokeWidth; /**< Width of the stroke of all drawn shapes */
+	uint32 _dynamicData; /**< Dynamic data from the GUI Theme that modifies the drawing of the current shape */
 
-	int _gradientFactor; /** Multiplication factor of the active gradient */
-	int _gradientBytes[3]; /** Color bytes of the active gradient, used to speed up calculation */
+	int _gradientFactor; /**< Multiplication factor of the active gradient */
+	int _gradientBytes[3]; /**< Color bytes of the active gradient, used to speed up calculation */
 	
 	static const ConvolutionDataSet _convolutionData[kConvolutionMAX];
 	
-	static const int _dimPercentValue = 256 * 50 / 100; /** default value for screen dimming (50%) */
+	static const int _dimPercentValue = 256 * 50 / 100; /**< default value for screen dimming (50%) */
 };
 
 } // end of namespace Graphics

Modified: scummvm/trunk/graphics/VectorRendererSpec.h
===================================================================
--- scummvm/trunk/graphics/VectorRendererSpec.h	2008-10-12 21:51:52 UTC (rev 34780)
+++ scummvm/trunk/graphics/VectorRendererSpec.h	2008-10-12 21:56:03 UTC (rev 34781)
@@ -194,7 +194,7 @@
     inline PixelType calcGradient(uint32 pos, uint32 max);
 
 	/**
-	 * Fills several pixels in a row with a given color and the specifed alpha blending.
+	 * Fills several pixels in a row with a given color and the specified alpha blending.
 	 *
 	 * @see blendPixelPtr
 	 * @see blendPixel
@@ -227,11 +227,11 @@
 	
 	void areaConvolution(const Common::Rect &area, const int filter[3][3], int filterDiv, int offset);
 
-	PixelType _fgColor; /** Foreground color currently being used to draw on the renderer */
-	PixelType _bgColor; /** Background color currently being used to draw on the renderer */
+	PixelType _fgColor; /**< Foreground color currently being used to draw on the renderer */
+	PixelType _bgColor; /**< Background color currently being used to draw on the renderer */
 
-	PixelType _gradientStart; /** Start color for the fill gradient */
-	PixelType _gradientEnd; /** End color for the fill gradient */
+	PixelType _gradientStart; /**< Start color for the fill gradient */
+	PixelType _gradientEnd; /**< End color for the fill gradient */
 	
 	PixelType _bevelColor;
 	PixelType _bitmapAlphaColor;
@@ -243,7 +243,7 @@
  *
  * This templated class inherits all the functionality of the VectorRendererSpec
  * class but uses better looking yet slightly slower AA algorithms for drawing
- * most primivitves. May be used in faster platforms.
+ * most primitives. May be used in faster platforms.
  *                    
  * TODO: Expand documentation.
  *


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.