Fix doxygen warning by renaming function

qgis · Jan 28, 2021 · 6ab0e4d · 6ab0e4d
1 parent 6606471
commit 6ab0e4d
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 25 deletions.
diff --git a/python/core/auto_generated/qgsmaprenderercache.sip.in b/python/core/auto_generated/qgsmaprenderercache.sip.in
@@ -64,9 +64,7 @@ Sets extent and scale parameters
 .. versionadded:: 3.18
 %End
 
-    void setCacheImage( const QString &cacheKey,
-                        const QImage &image,
-                        const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );
+    void setCacheImage( const QString &cacheKey, const QImage &image, const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );
 %Docstring
 Set the cached ``image`` for a particular ``cacheKey``, using the current cache parameters.
 
@@ -76,14 +74,16 @@ A list of ``dependentLayers`` should be passed containing all layer
 on which this cache image is dependent. If any of these layers triggers a
 repaint then the cache image will be cleared.
 
+.. seealso:: :py:func:`setCacheImageWithParameters`
+
 .. seealso:: :py:func:`cacheImage`
 %End
 
-    void setCacheImage( const QString &cacheKey,
-                        const QImage &image,
-                        const QgsRectangle &extent,
-                        const QgsMapToPixel &mapToPixel,
-                        const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );
+    void setCacheImageWithParameters( const QString &cacheKey,
+                                      const QImage &image,
+                                      const QgsRectangle &extent,
+                                      const QgsMapToPixel &mapToPixel,
+                                      const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );
 %Docstring
 Set the cached ``image`` for a particular ``cacheKey``, using a specific ``extent`` and ``mapToPixel``
 (which may differ from the current cache parameters).

diff --git a/src/core/qgsmaprenderercache.cpp b/src/core/qgsmaprenderercache.cpp
@@ -129,10 +129,10 @@ void QgsMapRendererCache::setCacheImage( const QString &cacheKey, const QImage &
   QgsMapToPixel mapToPixel = mMtp;
 
   lock.unlock();
-  setCacheImage( cacheKey, image, extent, mapToPixel, dependentLayers );
+  setCacheImageWithParameters( cacheKey, image, extent, mapToPixel, dependentLayers );
 }
 
-void QgsMapRendererCache::setCacheImage( const QString &cacheKey, const QImage &image, const QgsRectangle &extent, const QgsMapToPixel &mapToPixel, const QList<QgsMapLayer *> &dependentLayers )
+void QgsMapRendererCache::setCacheImageWithParameters( const QString &cacheKey, const QImage &image, const QgsRectangle &extent, const QgsMapToPixel &mapToPixel, const QList<QgsMapLayer *> &dependentLayers )
 {
   QMutexLocker lock( &mMutex );
 

diff --git a/src/core/qgsmaprenderercache.h b/src/core/qgsmaprenderercache.h
@@ -83,11 +83,10 @@ class CORE_EXPORT QgsMapRendererCache : public QObject
      * on which this cache image is dependent. If any of these layers triggers a
      * repaint then the cache image will be cleared.
      *
+     * \see setCacheImageWithParameters()
      * \see cacheImage()
      */
-    void setCacheImage( const QString &cacheKey,
-                        const QImage &image,
-                        const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );
+    void setCacheImage( const QString &cacheKey, const QImage &image, const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );
 
     /**
      * Set the cached \a image for a particular \a cacheKey, using a specific \a extent and \a mapToPixel
@@ -102,11 +101,11 @@ class CORE_EXPORT QgsMapRendererCache : public QObject
      * \see cacheImage()
      * \since QGIS 3.18
      */
-    void setCacheImage( const QString &cacheKey,
-                        const QImage &image,
-                        const QgsRectangle &extent,
-                        const QgsMapToPixel &mapToPixel,
-                        const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );
+    void setCacheImageWithParameters( const QString &cacheKey,
+                                      const QImage &image,
+                                      const QgsRectangle &extent,
+                                      const QgsMapToPixel &mapToPixel,
+                                      const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );
 
     /**
      * Returns TRUE if the cache contains an image with the specified \a cacheKey

diff --git a/src/core/qgsmaprendererjob.cpp b/src/core/qgsmaprendererjob.cpp
@@ -685,8 +685,8 @@ void QgsMapRendererJob::cleanupJobs( LayerRenderJobs &jobs )
       if ( mCache && !job.cached && job.completed && job.layer )
       {
         QgsDebugMsgLevel( QStringLiteral( "caching image for %1" ).arg( job.layerId ), 2 );
-        mCache->setCacheImage( job.layerId, *job.img, mSettings.visibleExtent(), mSettings.mapToPixel(), QList< QgsMapLayer * >() << job.layer );
-        mCache->setCacheImage( job.layerId + QStringLiteral( "_preview" ), *job.img, mSettings.visibleExtent(), mSettings.mapToPixel(), QList< QgsMapLayer * >() << job.layer );
+        mCache->setCacheImageWithParameters( job.layerId, *job.img, mSettings.visibleExtent(), mSettings.mapToPixel(), QList< QgsMapLayer * >() << job.layer );
+        mCache->setCacheImageWithParameters( job.layerId + QStringLiteral( "_preview" ), *job.img, mSettings.visibleExtent(), mSettings.mapToPixel(), QList< QgsMapLayer * >() << job.layer );
       }
 
       delete job.img;
@@ -751,8 +751,8 @@ void QgsMapRendererJob::cleanupLabelJob( LabelRenderJob &job )
     if ( mCache && !job.cached && !job.context.renderingStopped() )
     {
       QgsDebugMsgLevel( QStringLiteral( "caching label result image" ), 2 );
-      mCache->setCacheImage( LABEL_CACHE_ID, *job.img, mSettings.visibleExtent(), mSettings.mapToPixel(), _qgis_listQPointerToRaw( job.participatingLayers ) );
-      mCache->setCacheImage( LABEL_PREVIEW_CACHE_ID, *job.img, mSettings.visibleExtent(), mSettings.mapToPixel(), _qgis_listQPointerToRaw( job.participatingLayers ) );
+      mCache->setCacheImageWithParameters( LABEL_CACHE_ID, *job.img, mSettings.visibleExtent(), mSettings.mapToPixel(), _qgis_listQPointerToRaw( job.participatingLayers ) );
+      mCache->setCacheImageWithParameters( LABEL_PREVIEW_CACHE_ID, *job.img, mSettings.visibleExtent(), mSettings.mapToPixel(), _qgis_listQPointerToRaw( job.participatingLayers ) );
     }
 
     delete job.img;

diff --git a/tests/src/python/test_qgsmaprenderercache.py b/tests/src/python/test_qgsmaprenderercache.py
@@ -301,13 +301,13 @@ def testSetCacheImageDifferentParams(self):
         # if existing cached image exists with matching parameters, we don't store a new image -- old
         # one should still be retained
         im = QImage(201, 201, QImage.Format_RGB32)
-        cache.setCacheImage('im1', im, QgsRectangle(1, 1, 3, 4), QgsMapToPixel(5), [])
+        cache.setCacheImageWithParameters('im1', im, QgsRectangle(1, 1, 3, 4), QgsMapToPixel(5), [])
         self.assertEqual(cache.cacheImage('im1').width(), 200)
-        cache.setCacheImage('im1', im, QgsRectangle(1, 1, 3, 3), QgsMapToPixel(6), [])
+        cache.setCacheImageWithParameters('im1', im, QgsRectangle(1, 1, 3, 3), QgsMapToPixel(6), [])
         self.assertEqual(cache.cacheImage('im1').width(), 200)
 
         # replace with matching parameters
-        cache.setCacheImage('im1', im, QgsRectangle(1, 1, 3, 3), QgsMapToPixel(5), [])
+        cache.setCacheImageWithParameters('im1', im, QgsRectangle(1, 1, 3, 3), QgsMapToPixel(5), [])
         self.assertEqual(cache.cacheImage('im1').width(), 201)
         im = QImage(202, 202, QImage.Format_RGB32)
         cache.setCacheImage('im1', im, [])