Comments for documentation

qgis · Sep 3, 2012 · b84baeb · b84baeb
1 parent 52075eb
commit b84baeb
Showing 1 changed file with 29 additions and 1 deletion.
diff --git a/src/core/diagram/qgsdiagram.h b/src/core/diagram/qgsdiagram.h
@@ -38,13 +38,41 @@ class CORE_EXPORT QgsDiagram
     virtual QString diagramName() const = 0;
     /**Returns the size in map units the diagram will use to render.*/
     virtual QSizeF diagramSize( const QgsAttributeMap& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s ) = 0;
-    /**Returns the size in map units the diagram will use to render. Interpolat size*/
+    /**Returns the size in map units the diagram will use to render. Interpolate size*/
     virtual QSizeF diagramSize( const QgsAttributeMap& attributes, const QgsRenderContext& c, const QgsDiagramSettings& s, const QgsDiagramInterpolationSettings& is ) = 0;
 
   protected:
+    /** Changes the pen width to match the current settings and rendering context
+     *  @param pen The pen to modify
+     *  @param s   The settings that specify the pen width
+     *  @param c   The rendering specifying the proper scale units for pixel conversion
+     */
     void setPenWidth( QPen& pen, const QgsDiagramSettings& s, const QgsRenderContext& c );
+
+    /** Calculates a size to match the current settings and rendering context
+     *  @param size Unused
+     *  @param s    The settings that specify the diagram size
+     *  @param c    The rendering specifying the proper scale units for pixel conversion
+     *
+     *  @return The converted size for rendering
+     */
     QSizeF sizePainterUnits( const QSizeF& size, const QgsDiagramSettings& s, const QgsRenderContext& c );
+
+    /** Calculates a length to match the current settings and rendering context
+     *  @param l    The length to convert
+     *  @param s    Unused
+     *  @param c    The rendering specifying the proper scale units for pixel conversion
+     *
+     *  @return The converted length for rendering
+     */
     float sizePainterUnits( float l, const QgsDiagramSettings& s, const QgsRenderContext& c );
+
+    /** Calculates a size to match the current settings and rendering context
+     *  @param s    The settings that contain the font size and size type
+     *  @param c    The rendering specifying the proper scale units for pixel conversion
+     *
+     *  @return The properly scaled font for rendering
+     */
     QFont scaledFont( const QgsDiagramSettings& s, const QgsRenderContext& c );
 };