[composer] Improve picture rotation API docs

qgis · May 30, 2017 · 3cd99c3 · 3cd99c3
1 parent aaddfed
commit 3cd99c3
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 10 deletions.
diff --git a/src/core/composer/qgscomposerpicture.cpp b/src/core/composer/qgscomposerpicture.cpp
@@ -622,10 +622,10 @@ void QgsComposerPicture::setSceneRect( const QRectF &rectangle )
   }
 }
 
-void QgsComposerPicture::setPictureRotation( double r )
+void QgsComposerPicture::setPictureRotation( double rotation )
 {
   double oldRotation = mPictureRotation;
-  mPictureRotation = r;
+  mPictureRotation = rotation;
 
   if ( mResizeMode == Zoom )
   {

diff --git a/src/core/composer/qgscomposerpicture.h b/src/core/composer/qgscomposerpicture.h
@@ -105,11 +105,12 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
      */
     bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override;
 
-    /** Returns the rotation used for drawing the picture within the item's frame
-     * \returns picture rotation in degrees
+    /**
+     * Returns the rotation used for drawing the picture within the item's frame,
+     * in degrees clockwise.
      * \since QGIS 2.2
-     * \see setPictureRotation
-     * \see rotationMap
+     * \see setPictureRotation()
+     * \see rotationMap()
      */
     double pictureRotation() const { return mPictureRotation; }
 
@@ -254,13 +255,13 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
 
   public slots:
 
-    /** Sets the picture rotation within the item bounds. This does not affect
+    /**
+     * Sets the picture \a rotation within the item bounds, in degrees clockwise. This does not affect
      * the item's frame, only the way the picture is drawn within the item.
-     * \param r rotation in degrees clockwise
-     * \see pictureRotation
+     * \see pictureRotation()
      * \since QGIS 2.2
      */
-    virtual void setPictureRotation( double r );
+    virtual void setPictureRotation( double rotation );
 
     /** Sets the resize mode used for drawing the picture within the item bounds.
      * \param mode ResizeMode to use for image file