Add sip binding and comments

mhugent · mhugent · commit e5f8169aeb01 · 2018-04-19T10:32:48.000+02:00
diff --git a/python/core/dxf/qgsdxfexport.sip b/python/core/dxf/qgsdxfexport.sip
@@ -375,7 +375,14 @@ class QgsDxfExport
     //! @note added in 2.15
     void writeMText( const QString &layer, const QString &text, const QgsPointV2 &pt, double width, double angle, const QColor& color );
 
+    /** Returns scale factor for conversion to map units
+        @param mapUnitsPerPixel Map units per pixel*/
     static double mapUnitScaleFactor( double scaleDenominator, QgsSymbolV2::OutputUnit symbolUnits, QGis::UnitType mapUnits, double mapUnitsPerPixel = 1.0 );
+    /** Clips value to scale minimum/maximum
+        @param value the value to clip
+        @param scale the scale dependent minimum/maximum values
+        @param pixelToMMFactor pixels per mm*/
+    void clipValueToMapUnitScale( double& value, const QgsMapUnitScale& scale, double pixelToMMFactor ) const;
 
     //! Return cleaned layer name for use in DXF
     static QString dxfLayerName( const QString &name );
diff --git a/src/core/dxf/qgsdxfexport.h b/src/core/dxf/qgsdxfexport.h
@@ -402,7 +402,13 @@ class CORE_EXPORT QgsDxfExport
     //! @note added in 2.15
     void writeMText( const QString &layer, const QString &text, const QgsPointV2 &pt, double width, double angle, const QColor& color );
 
+    /** Returns scale factor for conversion to map units
+        @param mapUnitsPerPixel Map units per pixel*/
     static double mapUnitScaleFactor( double scaleDenominator, QgsSymbolV2::OutputUnit symbolUnits, QGis::UnitType mapUnits, double mapUnitsPerPixel = 1.0 );
+    /** Clips value to scale minimum/maximum
+        @param value the value to clip
+        @param scale the scale dependent minimum/maximum values
+        @param pixelToMMFactor pixels per mm*/
     void clipValueToMapUnitScale( double& value, const QgsMapUnitScale& scale, double pixelToMMFactor ) const;
 
     //! Return cleaned layer name for use in DXF
diff --git a/src/core/dxf/qgsdxfpaintengine.h b/src/core/dxf/qgsdxfpaintengine.h
@@ -61,6 +61,7 @@ class CORE_EXPORT QgsDxfPaintEngine: public QPaintEngine
     QTransform mTransform;
     QPen mPen;
     QBrush mBrush;
+    /** Opacity*/
     double mOpacity;
     QString mLayer;
     QPointF mShift;
@@ -86,7 +87,9 @@ class CORE_EXPORT QgsDxfPaintEngine: public QPaintEngine
     static double power( double a, int b );
     static int faculty( int n );
 
+    /** Returns current pen color*/
     QColor penColor() const;
+    /** Returns current brush color*/
     QColor brushColor() const;
 };
 
