More descriptive parameter name and comment

qgis · Dec 8, 2011 · 94984a3 · 94984a3
1 parent 365c33d
commit 94984a3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/src/core/qgsmaprenderer.cpp b/src/core/qgsmaprenderer.cpp
@@ -213,7 +213,7 @@ void QgsMapRenderer::adjustExtentToSize()
 }
 
 
-void QgsMapRenderer::render( QPainter* painter, double* forceScaleFactor )
+void QgsMapRenderer::render( QPainter* painter, double* forceWidthScale )
 {
   //Lock render method for concurrent threads (e.g. from globe)
   QMutexLocker renderLock( &mRenderMutex );
@@ -282,9 +282,9 @@ void QgsMapRenderer::render( QPainter* painter, double* forceScaleFactor )
   double scaleFactor = 1.0;
   if ( mOutputUnits == QgsMapRenderer::Millimeters )
   {
-    if ( forceScaleFactor )
+    if ( forceWidthScale )
     {
-      scaleFactor = *forceScaleFactor;
+      scaleFactor = *forceWidthScale;
     }
     else
     {

diff --git a/src/core/qgsmaprenderer.h b/src/core/qgsmaprenderer.h
@@ -120,7 +120,8 @@ class CORE_EXPORT QgsMapRenderer : public QObject
     ~QgsMapRenderer();
 
     //! starts rendering
-    void render( QPainter* painter, double* forceScaleFactor = 0 );
+    //! @ param forceWidthScale Force a specific scale factor for line widths and marker sizes. Automatically calculated from output device DPI if 0
+    void render( QPainter* painter, double* forceWidthScale = 0 );
 
     //! sets extent and checks whether suitable (returns false if not)
     bool setExtent( const QgsRectangle& extent );