Updated comments/documentation

git-svn-id: http://svn.osgeo.org/qgis/trunk@1700 c8812cc2-4d05-0410-92ff-de0c093fc19c

src/qgsacetateobject.h

@@ -23,7 +23,7 @@ class QgsPoint;
 class QPainter;
 class QgsCoordinateTransform;
 
-/** \class QgsAcetateObject
+/*! \class QgsAcetateObject
 * \brief Base class for all objects that are drawn on the acetate layer of a map canvas.
 *
 * An acetate object is a graphic or text object that is drawn on top of the map canvas 

src/qgsacetaterectangle.h

@@ -27,56 +27,56 @@ class QgsCoordinateTransform;
 #include "qgsacetateobject.h"
 
 /** \class QgsAcetateRectangle
-* \brief A rectangle drawn on the acetate layer of a map canvas
+ * \brief A rectangle drawn on the acetate layer of a map canvas
-*
+ *
-* An acetate object is a graphic or text object that is drawn on top of the map canvas 
+ * An acetate object is a graphic or text object that is drawn on top of the map canvas 
-* after rendering of all map elements is completed. Acetate objects can be drawn in
+ * after rendering of all map elements is completed. Acetate objects can be drawn in
-* device coordinates or map coordinates. Drawing in map coordinates requires passing
+ * device coordinates or map coordinates. Drawing in map coordinates requires passing
-* a QgsCoordinateTransform object to the draw function.
+ * a QgsCoordinateTransform object to the draw function.
-*
+ *
-*/ 
+ */ 
 class QgsAcetateRectangle : public QgsAcetateObject {
-public:
+  public:
-  /**
+    /**
-   * Constructor. Constructs an object with the specified origin. If the object is
+     * Constructor. Constructs an object with the specified origin. If the object is
-   * spatially referenced, the origin should be in map coordinates.
+     * spatially referenced, the origin should be in map coordinates.
-   */
+     */
-  QgsAcetateRectangle(QgsPoint &origin, const QgsRect &rectangle);
+    QgsAcetateRectangle(QgsPoint &origin, const QgsRect &rectangle);
-	/** 
+    /** 
-	 * Destructor
+     * Destructor
-	 */
+     */
-	~QgsAcetateRectangle();
+    ~QgsAcetateRectangle();
-  /**
+    /**
-   * Draw the rectangle using the Qpainter and applying a coordinate transform if
+     * Draw the rectangle using the Qpainter and applying a coordinate transform if
-   * specified.
+     * specified.
-   * @param painter Painter to use for drawing
+     * @param painter Painter to use for drawing
-   * @param cXf Coordinate transform to use in drawing map coordinate on the device. If 
+     * @param cXf Coordinate transform to use in drawing map coordinate on the device. If 
-   * this parameter is not specified, coordinates are assumed to be device coordinates
+     * this parameter is not specified, coordinates are assumed to be device coordinates
-   * rather than map coordinates.
+     * rather than map coordinates.
-   */
+     */
-  void  draw (QPainter * painter, QgsCoordinateTransform * cXf=0);
+    void  draw (QPainter * painter, QgsCoordinateTransform * cXf=0);
-   /** 
+    /** 
-    * Set the origin point
+     * Set the origin point
-    * @param value Point of origin
+     * @param value Point of origin
-    */
+     */
-  void setOrigin (QgsPoint value );
+    void setOrigin (QgsPoint value );
- /**
+    /**
-  * Returns the point of origin
+     * Returns the point of origin
-  */
+     */
-  QgsPoint origin();
+    QgsPoint origin();
-  /**
+    /**
-   * Returns the current rectangle
+     * Returns the current rectangle
-   */
+     */
-  QgsRect rectangle();
+    QgsRect rectangle();
-  /** Sets the rectangle
+    /** Sets the rectangle
-   * @param rect The rectanlge
+     * @param rect The rectanlge
-   */
+     */
-  void setRectangle(QgsRect value);
+    void setRectangle(QgsRect value);
-private:
+  private:
-  //! Origin of the object in device or map coordinates 
+    //! Origin of the object in device or map coordinates 
-   QgsPoint mOrigin;
+    QgsPoint mOrigin;
-   //! Rectangle
+    //! Rectangle
-   QgsRect mRectangle;
+    QgsRect mRectangle;
 };
 #endif //QGSACETATERECTANGLE_H