Skip to content

Commit f4bbb14

Browse files
committed
Dox++
1 parent d26f25c commit f4bbb14

File tree

2 files changed

+41
-14
lines changed

2 files changed

+41
-14
lines changed

python/analysis/auto_generated/raster/qgsrastercalculator.sip.in

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,31 @@
1010

1111

1212

13-
14-
struct QgsRasterCalculatorEntry
13+
class QgsRasterCalculatorEntry
1514
{
15+
%Docstring
16+
Represents an individual raster layer/band number entry within a raster calculation.
17+
%End
18+
19+
%TypeHeaderCode
20+
#include "qgsrastercalculator.h"
1621
%TypeHeaderCode
1722
#include <qgsrastercalculator.h>
1823
%End
24+
%End
25+
public:
26+
27+
QString ref;
28+
29+
QgsRasterLayer *raster;
1930

20-
QString ref; //name
21-
QgsRasterLayer *raster; //pointer to rasterlayer
22-
int bandNumber; //raster band number
31+
int bandNumber;
2332
};
2433

2534
class QgsRasterCalculator
2635
{
2736
%Docstring
28-
Raster calculator class*
37+
Performs raster layer calculations.
2938
%End
3039

3140
%TypeHeaderCode

src/analysis/raster/qgsrastercalculator.h

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,41 @@
2929
class QgsRasterLayer;
3030
class QgsFeedback;
3131

32-
33-
struct ANALYSIS_EXPORT QgsRasterCalculatorEntry
32+
/**
33+
* \ingroup analysis
34+
* \class QgsRasterCalculatorEntry
35+
* Represents an individual raster layer/band number entry within a raster calculation.
36+
*/
37+
class ANALYSIS_EXPORT QgsRasterCalculatorEntry
3438
{
3539
#ifdef SIP_RUN
36-
% TypeHeaderCode
40+
% TypeHeaderCode
3741
#include <qgsrastercalculator.h>
38-
% End
42+
% End
3943
#endif
4044

41-
QString ref; //name
42-
QgsRasterLayer *raster; //pointer to rasterlayer
43-
int bandNumber; //raster band number
45+
public:
46+
47+
/**
48+
* Name of entry.
49+
*/
50+
QString ref;
51+
52+
/**
53+
* Raster layer associated with entry.
54+
*/
55+
QgsRasterLayer *raster = nullptr;
56+
57+
/**
58+
* Band number for entry. Numbering for bands usually starts at 1 for the first band, not 0.
59+
*/
60+
int bandNumber = 1;
4461
};
4562

4663
/**
4764
* \ingroup analysis
48-
* Raster calculator class*/
65+
* Performs raster layer calculations.
66+
*/
4967
class ANALYSIS_EXPORT QgsRasterCalculator
5068
{
5169
public:

0 commit comments

Comments
 (0)