Improve QgsRasterIdentifyResult docs

qgis · Oct 26, 2020 · add4fec · add4fec
1 parent fe2faaa
commit add4fec
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/python/core/auto_generated/raster/qgsrasteridentifyresult.sip.in b/python/core/auto_generated/raster/qgsrasteridentifyresult.sip.in
@@ -55,9 +55,10 @@ Returns the results format.
     QMap<int, QVariant> results() const;
 %Docstring
 Returns the identify results. Results are different for each format:
-QgsRaster.IdentifyFormatValue: map of values for each band, keys are band numbers (from 1).
-QgsRaster.IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer (WMS)
-QgsRaster.IdentifyFormatHtml: map of HTML strings for each sublayer (WMS).
+
+- QgsRaster.IdentifyFormatValue: a map of values for each band, where keys are band numbers (from 1).
+- QgsRaster.IdentifyFormatFeature: a map of WMS sublayer keys and lists of QgsFeatureStore values.
+- QgsRaster.IdentifyFormatHtml: a map of WMS sublayer keys and HTML strings.
 %End
 
     void setParams( const QMap<QString, QVariant> &params );

diff --git a/src/core/raster/qgsrasteridentifyresult.h b/src/core/raster/qgsrasteridentifyresult.h
@@ -59,9 +59,10 @@ class CORE_EXPORT QgsRasterIdentifyResult
 
     /**
      * Returns the identify results. Results are different for each format:
-     * QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers (from 1).
-     * QgsRaster::IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer (WMS)
-     * QgsRaster::IdentifyFormatHtml: map of HTML strings for each sublayer (WMS).
+     *
+     * - QgsRaster::IdentifyFormatValue: a map of values for each band, where keys are band numbers (from 1).
+     * - QgsRaster::IdentifyFormatFeature: a map of WMS sublayer keys and lists of QgsFeatureStore values.
+     * - QgsRaster::IdentifyFormatHtml: a map of WMS sublayer keys and HTML strings.
      */
     QMap<int, QVariant> results() const { return mResults; }