add wms caching note to QgsRasterDataProvider::draw()

jef-n · jef-n · commit a46d7c06e305 · 2014-02-20T15:16:26.000+01:00
diff --git a/src/core/raster/qgsrasterdataprovider.h b/src/core/raster/qgsrasterdataprovider.h
@@ -66,7 +66,13 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast
     /* It makes no sense to set input on provider */
     bool setInput( QgsRasterInterface* input ) { Q_UNUSED( input ); return false; }
 
-    /** \brief   Renders the layer as an image */
+    /** \brief   Renders the layer as an image
+	\note When render caching (/qgis/enable_render_caching) is on the wms
+	      provider doesn't wait for the reply of the getmap request or all
+	      tiles replies and can return incomplete images.
+	      Temporarily disable render caching if you require the complete
+	      wms image in the first call.
+      */
     virtual QImage* draw( const QgsRectangle & viewExtent, int pixelWidth, int pixelHeight ) = 0;
 
     /** Get the extent of the data source.
