Dox++

qgis · Sep 25, 2018 · f4bbb14 · f4bbb14
1 parent d26f25c
commit f4bbb14
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 14 deletions.
diff --git a/python/analysis/auto_generated/raster/qgsrastercalculator.sip.in b/python/analysis/auto_generated/raster/qgsrastercalculator.sip.in
@@ -10,22 +10,31 @@
 
 
 
-
-struct QgsRasterCalculatorEntry
+class QgsRasterCalculatorEntry
 {
+%Docstring
+Represents an individual raster layer/band number entry within a raster calculation.
+%End
+
+%TypeHeaderCode
+#include "qgsrastercalculator.h"
 %TypeHeaderCode
 #include <qgsrastercalculator.h>
 %End
+%End
+  public:
+
+    QString ref;
+
+    QgsRasterLayer *raster;
 
-  QString ref; //name
-  QgsRasterLayer *raster; //pointer to rasterlayer
-  int bandNumber; //raster band number
+    int bandNumber;
 };
 
 class QgsRasterCalculator
 {
 %Docstring
-Raster calculator class*
+Performs raster layer calculations.
 %End
 
 %TypeHeaderCode

diff --git a/src/analysis/raster/qgsrastercalculator.h b/src/analysis/raster/qgsrastercalculator.h
@@ -29,23 +29,41 @@
 class QgsRasterLayer;
 class QgsFeedback;
 
-
-struct ANALYSIS_EXPORT QgsRasterCalculatorEntry
+/**
+ * \ingroup analysis
+ * \class QgsRasterCalculatorEntry
+ * Represents an individual raster layer/band number entry within a raster calculation.
+*/
+class ANALYSIS_EXPORT QgsRasterCalculatorEntry
 {
 #ifdef SIP_RUN
-  % TypeHeaderCode
+    % TypeHeaderCode
 #include <qgsrastercalculator.h>
-  % End
+    % End
 #endif
 
-  QString ref; //name
-  QgsRasterLayer *raster; //pointer to rasterlayer
-  int bandNumber; //raster band number
+  public:
+
+    /**
+     * Name of entry.
+     */
+    QString ref;
+
+    /**
+     * Raster layer associated with entry.
+     */
+    QgsRasterLayer *raster = nullptr;
+
+    /**
+     * Band number for entry. Numbering for bands usually starts at 1 for the first band, not 0.
+     */
+    int bandNumber = 1;
 };
 
 /**
  * \ingroup analysis
- * Raster calculator class*/
+ * Performs raster layer calculations.
+*/
 class ANALYSIS_EXPORT QgsRasterCalculator
 {
   public: