Skip to content

Commit 9b04589

Browse files
committed
More missing docs
1 parent 6166d21 commit 9b04589

File tree

10 files changed

+54
-0
lines changed

10 files changed

+54
-0
lines changed

python/analysis/network/qgsgraph.sip

+4
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,11 @@ class QgsGraph
107107
#include "qgsgraph.h"
108108
%End
109109
public:
110+
110111
QgsGraph();
112+
%Docstring
113+
Constructor for QgsGraph.
114+
%End
111115

112116

113117
int addVertex( const QgsPointXY &pt );

python/core/diagram/qgsdiagram.sip

+5
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ class QgsDiagram
1919
#include "qgsdiagram.h"
2020
%End
2121
public:
22+
2223
virtual ~QgsDiagram();
2324

2425
virtual QgsDiagram *clone() const = 0 /Factory/;
@@ -71,7 +72,11 @@ Returns the size in map units the diagram will use to render. Interpolate size
7172
%End
7273

7374
protected:
75+
7476
QgsDiagram();
77+
%Docstring
78+
Constructor for QgsDiagram.
79+
%End
7580
QgsDiagram( const QgsDiagram &other );
7681

7782
void setPenWidth( QPen &pen, const QgsDiagramSettings &s, const QgsRenderContext &c );

python/core/qgscredentials.sip

+4
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,11 @@ retrieves instance
7373
%End
7474

7575
protected:
76+
7677
QgsCredentials();
78+
%Docstring
79+
Constructor for QgsCredentials.
80+
%End
7781

7882
virtual bool request( const QString &realm, QString &username /In,Out/, QString &password /In,Out/, const QString &message = QString() ) = 0;
7983
%Docstring

python/core/qgsreadwritecontext.sip

+4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@ class QgsReadWriteContext
2020
#include "qgsreadwritecontext.h"
2121
%End
2222
public:
23+
2324
QgsReadWriteContext();
25+
%Docstring
26+
Constructor for QgsReadWriteContext.
27+
%End
2428

2529
const QgsPathResolver &pathResolver() const;
2630
%Docstring

python/core/raster/qgsrastertransparency.sip

+10
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ class QgsRasterTransparency
1919
#include "qgsrastertransparency.h"
2020
%End
2121
public:
22+
2223
QgsRasterTransparency();
24+
%Docstring
25+
Constructor for QgsRasterTransparency.
26+
%End
2327

2428
struct TransparentThreeValuePixel
2529
{
@@ -87,8 +91,14 @@ True if there are no entries in the pixel lists except the nodata value
8791
%End
8892

8993
void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
94+
%Docstring
95+
Writes the transparency information to an XML document.
96+
%End
9097

9198
void readXml( const QDomElement &elem );
99+
%Docstring
100+
Reads the transparency information from an XML document.
101+
%End
92102

93103
};
94104
/************************************************************************

src/analysis/network/qgsgraph.h

+4
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,10 @@ class ANALYSIS_EXPORT QgsGraphVertex
131131
class ANALYSIS_EXPORT QgsGraph
132132
{
133133
public:
134+
135+
/**
136+
* Constructor for QgsGraph.
137+
*/
134138
QgsGraph() = default;
135139

136140
// Graph constructing methods

src/core/diagram/qgsdiagram.h

+5
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ class QgsAttributes;
3737
class CORE_EXPORT QgsDiagram
3838
{
3939
public:
40+
4041
virtual ~QgsDiagram() { clearCache(); }
4142

4243
/** Returns an instance that is equivalent to this one
@@ -73,6 +74,10 @@ class CORE_EXPORT QgsDiagram
7374
virtual double legendSize( double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is ) const = 0;
7475

7576
protected:
77+
78+
/**
79+
* Constructor for QgsDiagram.
80+
*/
7681
QgsDiagram() = default;
7782
QgsDiagram( const QgsDiagram &other );
7883

src/core/qgscredentials.h

+4
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ class CORE_EXPORT QgsCredentials
7575
QMutex *mutex() { return &mMutex; }
7676

7777
protected:
78+
79+
/**
80+
* Constructor for QgsCredentials.
81+
*/
7882
QgsCredentials() = default;
7983

8084
//! request a password

src/core/qgsreadwritecontext.h

+4
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@
2929
class CORE_EXPORT QgsReadWriteContext
3030
{
3131
public:
32+
33+
/**
34+
* Constructor for QgsReadWriteContext.
35+
*/
3236
QgsReadWriteContext() = default;
3337

3438
//! Returns path resolver for conversion between relative and absolute paths

src/core/raster/qgsrastertransparency.h

+10
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ class CORE_EXPORT QgsRasterTransparency
3232
{
3333

3434
public:
35+
36+
/**
37+
* Constructor for QgsRasterTransparency.
38+
*/
3539
QgsRasterTransparency() = default;
3640

3741
//
@@ -82,8 +86,14 @@ class CORE_EXPORT QgsRasterTransparency
8286
//! True if there are no entries in the pixel lists except the nodata value
8387
bool isEmpty() const;
8488

89+
/**
90+
* Writes the transparency information to an XML document.
91+
*/
8592
void writeXml( QDomDocument &doc, QDomElement &parentElem ) const;
8693

94+
/**
95+
* Reads the transparency information from an XML document.
96+
*/
8797
void readXml( const QDomElement &elem );
8898

8999
private:

0 commit comments

Comments
 (0)