Dox++

nyalldawson · nyalldawson · commit b747ff63013a · 2018-07-20T07:24:35.000+10:00
diff --git a/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in b/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in
@@ -288,6 +288,8 @@ is supported by provider.
 
 A null QVariant will be returned if the point is outside data source extent.
 
+.. seealso:: :py:func:`identify`
+
 .. versionadded:: 3.4
 %End
 
diff --git a/src/core/raster/qgsrasterdataprovider.h b/src/core/raster/qgsrasterdataprovider.h
@@ -355,7 +355,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast
      *         Empty if failed or there are no results (TODO: better error reporting).
      * \note The arbitraryness of the returned document is enforced by WMS standards
      *       up to at least v1.3.0
-     * \see sample()
+     * \see sample(), which is much more efficient for simple "value at point" queries.
      */
     virtual QgsRasterIdentifyResult identify( const QgsPointXY &point, QgsRaster::IdentifyFormat format, const QgsRectangle &boundingBox = QgsRectangle(), int width = 0, int height = 0, int dpi = 96 );
 
@@ -369,6 +369,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast
      *
      * A null QVariant will be returned if the point is outside data source extent.
      *
+     * \see identify(), which is much more flexible but considerably less efficient.
      * \since QGIS 3.4
      */
     virtual QVariant sample( const QgsPointXY &point, int band, const QgsRectangle &boundingBox = QgsRectangle(), int width = 0, int height = 0, int dpi = 96 );
