Add missing docs

qgis · Jul 26, 2016 · 813ed5e · 813ed5e
1 parent f186c11
commit 813ed5e
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 2 deletions.
diff --git a/python/core/symbology-ng/qgsellipsesymbollayerv2.sip b/python/core/symbology-ng/qgsellipsesymbollayerv2.sip
@@ -51,7 +51,17 @@ class QgsEllipseSymbolLayerV2 : QgsMarkerSymbolLayerV2
     void setOutlineColor( const QColor& c );
     QColor outlineColor() const;
 
+    /** Sets the units for the symbol's width.
+     * @param unit symbol units
+     * @see symbolWidthUnit()
+     * @see setSymbolHeightUnit()
+    */
     void setSymbolWidthUnit( QgsUnitTypes::RenderUnit unit );
+
+    /** Returns the units for the symbol's width.
+     * @see setSymbolWidthUnit()
+     * @see symbolHeightUnit()
+    */
     QgsUnitTypes::RenderUnit symbolWidthUnit() const;
 
     void setSymbolWidthMapUnitScale( const QgsMapUnitScale& scale);
@@ -60,11 +70,13 @@ class QgsEllipseSymbolLayerV2 : QgsMarkerSymbolLayerV2
     /** Sets the units for the symbol's height.
      * @param unit symbol units
      * @see symbolHeightUnit()
+     * @see setSymbolWidthUnit()
     */
     void setSymbolHeightUnit( QgsUnitTypes::RenderUnit unit );
 
     /** Returns the units for the symbol's height.
      * @see setSymbolHeightUnit()
+     * @see symbolWidthUnit()
     */
     QgsUnitTypes::RenderUnit symbolHeightUnit() const;
 

diff --git a/python/core/symbology-ng/qgssymbolv2.sip b/python/core/symbology-ng/qgssymbolv2.sip
@@ -155,7 +155,7 @@ class QgsSymbolV2
      * @param unit output units
      * @see outputUnit()
      */
-    void setOutputUnit( QgsUnitTypes::RenderUnit u );
+    void setOutputUnit( QgsUnitTypes::RenderUnit unit );
 
     QgsMapUnitScale mapUnitScale() const;
     void setMapUnitScale( const QgsMapUnitScale& scale );

diff --git a/src/core/symbology-ng/qgsellipsesymbollayerv2.h b/src/core/symbology-ng/qgsellipsesymbollayerv2.h
@@ -73,7 +73,17 @@ class CORE_EXPORT QgsEllipseSymbolLayerV2: public QgsMarkerSymbolLayerV2
     void setOutlineColor( const QColor& c ) override { mOutlineColor = c; }
     QColor outlineColor() const override { return mOutlineColor; }
 
+    /** Sets the units for the symbol's width.
+     * @param unit symbol units
+     * @see symbolWidthUnit()
+     * @see setSymbolHeightUnit()
+    */
     void setSymbolWidthUnit( QgsUnitTypes::RenderUnit unit ) { mSymbolWidthUnit = unit; }
+
+    /** Returns the units for the symbol's width.
+     * @see setSymbolWidthUnit()
+     * @see symbolHeightUnit()
+    */
     QgsUnitTypes::RenderUnit symbolWidthUnit() const { return mSymbolWidthUnit; }
 
     void setSymbolWidthMapUnitScale( const QgsMapUnitScale& scale ) { mSymbolWidthMapUnitScale = scale; }
@@ -82,11 +92,13 @@ class CORE_EXPORT QgsEllipseSymbolLayerV2: public QgsMarkerSymbolLayerV2
     /** Sets the units for the symbol's height.
      * @param unit symbol units
      * @see symbolHeightUnit()
+     * @see setSymbolWidthUnit()
     */
     void setSymbolHeightUnit( QgsUnitTypes::RenderUnit unit ) { mSymbolHeightUnit = unit; }
 
     /** Returns the units for the symbol's height.
      * @see setSymbolHeightUnit()
+     * @see symbolWidthUnit()
     */
     QgsUnitTypes::RenderUnit symbolHeightUnit() const { return mSymbolHeightUnit; }
 

diff --git a/src/core/symbology-ng/qgssymbolv2.h b/src/core/symbology-ng/qgssymbolv2.h
@@ -193,7 +193,7 @@ class CORE_EXPORT QgsSymbolV2
      * @param unit output units
      * @see outputUnit()
      */
-    void setOutputUnit( QgsUnitTypes::RenderUnit u );
+    void setOutputUnit( QgsUnitTypes::RenderUnit unit );
 
     QgsMapUnitScale mapUnitScale() const;
     void setMapUnitScale( const QgsMapUnitScale& scale );