More docs

qgis · Sep 9, 2020 · 47a48bb · 47a48bb
1 parent 94fe2f8
commit 47a48bb
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/python/analysis/auto_generated/vector/qgszonalstatistics.sip.in b/python/analysis/auto_generated/vector/qgszonalstatistics.sip.in
@@ -50,7 +50,7 @@ A class that calculates raster statistics (count, sum, mean) for a polygon or mu
       RasterInvalid,
       RasterBandInvalid,
       FailedToCreateField,
-      Cancelled
+      Canceled
     };
 
     QgsZonalStatistics( QgsVectorLayer *polygonLayer,

diff --git a/src/analysis/vector/qgszonalstatistics.cpp b/src/analysis/vector/qgszonalstatistics.cpp
@@ -160,7 +160,7 @@ QgsZonalStatistics::Result QgsZonalStatistics::calculateStatistics( QgsFeedback
   if ( feedback )
   {
     if ( feedback->isCanceled() )
-      return Cancelled;
+      return Canceled;
 
     feedback->setProgress( 100 );
   }

diff --git a/src/analysis/vector/qgszonalstatistics.h b/src/analysis/vector/qgszonalstatistics.h
@@ -66,15 +66,16 @@ class ANALYSIS_EXPORT QgsZonalStatistics
     };
     Q_DECLARE_FLAGS( Statistics, Statistic )
 
+    //! Error codes for calculation
     enum Result
     {
-      Success = 0,
-      LayerTypeWrong = 1,
-      LayerInvalid,
-      RasterInvalid,
-      RasterBandInvalid,
-      FailedToCreateField = 8,
-      Cancelled = 9
+      Success = 0, //!< Success
+      LayerTypeWrong = 1, //!< Layer is not a polygon layer
+      LayerInvalid, //!< Layer is invalid
+      RasterInvalid, //!< Raster layer is invalid
+      RasterBandInvalid, //!< The raster band does not exist on the raster layer
+      FailedToCreateField = 8, //!< Output fields could not be created
+      Canceled = 9 //!< Algorithm was canceled
     };
 
     /**