Skip to content

Commit 929df96

Browse files
m-kuhnm-kuhn
committedDec 22, 2018
Remaining docs
·
ltr-3_40final-3_6_0
1 parent d3f64de commit 929df96

File tree

7 files changed

+74
-6
lines changed

7 files changed

+74
-6
lines changed
 

‎python/analysis/auto_generated/vector/geometry_checker/qgsgeometrycheckfactory.sip.in

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ The type of this check.
6666
template<T>
6767
class QgsGeometryCheckFactoryT : QgsGeometryCheckFactory
6868
{
69+
%Docstring
70+
Template to create a factory for a geometry check.
71+
72+
.. note::
73+
74+
Not available in Python bindings.
75+
%End
6976

7077
%TypeHeaderCode
7178
#include "qgsgeometrycheckfactory.h"

‎python/analysis/auto_generated/vector/geometry_checker/qgssinglegeometrycheck.sip.in

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@ An error from a QgsSingleGeometryCheck.
2828
#include "qgssinglegeometrycheck.h"
2929
%End
3030
public:
31+
3132
QgsSingleGeometryCheckError( const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QgsVertexId &vertexId = QgsVertexId() );
33+
%Docstring
34+
Creates a new single geometry check error.
35+
%End
3236

3337
virtual ~QgsSingleGeometryCheckError();
3438

@@ -93,7 +97,11 @@ The single error can be obtained via singleError.
9397
#include "qgssinglegeometrycheck.h"
9498
%End
9599
public:
100+
96101
QgsGeometryCheckErrorSingle( QgsSingleGeometryCheckError *singleError, const QgsGeometryCheckerUtils::LayerFeature &layerFeature );
102+
%Docstring
103+
Creates a new error for a :py:class:`QgsSingleGeometryCheck`.
104+
%End
97105

98106
QgsSingleGeometryCheckError *singleError() const;
99107
%Docstring

‎src/analysis/vector/geometry_checker/qgsgeometrycheck.h

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,11 @@ class ANALYSIS_EXPORT QgsGeometryCheck
173173
virtual ~QgsGeometryCheck() = default;
174174

175175
#ifndef SIP_RUN
176+
177+
/**
178+
* Returns the configuration value with the \a name, saved in the QGIS settings for
179+
* this geometry check. If no configuration could be found, \a defaultValue is returned.
180+
*/
176181
template <class T>
177182
T configurationValue( const QString &name, const QVariant &defaultValue = QVariant() )
178183
{
@@ -265,35 +270,35 @@ class ANALYSIS_EXPORT QgsGeometryCheck
265270
/**
266271
* Replaces a part in a feature geometry.
267272
*
268-
* \since QGIS 3.4
269273
* \note Not available in Python bindings
274+
* \since QGIS 3.4
270275
*/
271276
void replaceFeatureGeometryPart( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, QgsAbstractGeometry *newPartGeom, Changes &changes ) const SIP_SKIP;
272277

273278
/**
274279
* Deletes a part of a feature geometry.
275280
*
276-
* \since QGIS 3.4
277281
* \note Not available in Python bindings
282+
* \since QGIS 3.4
278283
*/
279284
void deleteFeatureGeometryPart( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, Changes &changes ) const SIP_SKIP;
280285

281286
/**
282287
* Deletes a ring in a feature geometry.
283288
*
284-
* \since QGIS 3.4
285289
* \note Not available in Python bindings
290+
* \since QGIS 3.4
286291
*/
287292
void deleteFeatureGeometryRing( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, int ringIdx, Changes &changes ) const SIP_SKIP;
288293

289294
const QgsGeometryCheckContext *mContext;
290295
QVariantMap mConfiguration;
291296

292297
/**
293-
* Determin the scale factor of a layer to the map coordiante reference system.
298+
* Determines the scale factor of a layer to the map coordinate reference system.
294299
*
295-
* \since QGIS 3.4
296300
* \note Not available in Python bindings
301+
* \since QGIS 3.4
297302
*/
298303
double scaleFactor( const QPointer<QgsVectorLayer> &layer ) const SIP_SKIP;
299304
};

‎src/analysis/vector/geometry_checker/qgsgeometrycheckerutils.h

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,20 @@ class ANALYSIS_EXPORT QgsGeometryCheckerUtils
113113
{
114114
public:
115115
#ifndef SIP_RUN
116+
117+
/**
118+
* Creates a new set of layer and features.
119+
*/
116120
LayerFeatures( const QMap<QString, QgsFeaturePool *> &featurePools,
117121
const QMap<QString, QgsFeatureIds> &featureIds,
118122
const QList<QgsWkbTypes::GeometryType> &geometryTypes,
119123
QgsFeedback *feedback,
120124
const QgsGeometryCheckContext *context,
121125
bool useMapCrs = false );
122126

127+
/**
128+
* Creates a new set of layer and features.
129+
*/
123130
LayerFeatures( const QMap<QString, QgsFeaturePool *> &featurePools,
124131
const QList<QString> &layerIds, const QgsRectangle &extent,
125132
const QList<QgsWkbTypes::GeometryType> &geometryTypes,
@@ -135,11 +142,33 @@ class ANALYSIS_EXPORT QgsGeometryCheckerUtils
135142
class iterator
136143
{
137144
public:
145+
146+
/**
147+
* Creates a new iterator.
148+
*/
138149
iterator( const QList<QString>::const_iterator &layerIt, const LayerFeatures *parent );
150+
151+
/**
152+
* Copies the iterator \a rh.
153+
*/
139154
iterator( const iterator &rh );
140155
~iterator();
156+
157+
/**
158+
* Increments the item the iterator currently points to by one and
159+
* returns the new iterator.
160+
*/
141161
const iterator &operator++();
142-
iterator operator++( int );
162+
163+
/**
164+
* Increments the item the iterator currently points to by \a n and
165+
* returns the new iterator.
166+
*/
167+
iterator operator++( int n );
168+
169+
/**
170+
* Dereferences the item at the current iterator location.
171+
*/
143172
const QgsGeometryCheckerUtils::LayerFeature &operator*() const;
144173
bool operator!=( const iterator &other );
145174

‎src/analysis/vector/geometry_checker/qgsgeometrycheckfactory.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,11 @@ class ANALYSIS_EXPORT QgsGeometryCheckFactory SIP_ABSTRACT
8282
virtual QgsGeometryCheck::CheckType checkType() const = 0;
8383
};
8484

85+
/**
86+
* Template to create a factory for a geometry check.
87+
*
88+
* \note Not available in Python bindings.
89+
*/
8590
template<class T>
8691
class QgsGeometryCheckFactoryT : public QgsGeometryCheckFactory
8792
{

‎src/analysis/vector/geometry_checker/qgsgeometryisvalidcheck.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ email : matthias@opengis.ch
3131
class ANALYSIS_EXPORT QgsGeometryIsValidCheckError : public QgsSingleGeometryCheckError
3232
{
3333
public:
34+
35+
/**
36+
* Creates a new is valid check error.
37+
*/
3438
QgsGeometryIsValidCheckError( const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QString &errorDescription );
3539

3640
QString description() const override;
@@ -40,6 +44,8 @@ class ANALYSIS_EXPORT QgsGeometryIsValidCheckError : public QgsSingleGeometryChe
4044
};
4145

4246
/**
47+
* \ingroup analysis
48+
*
4349
* Checks if geometries are valid using the backend configured in the QGIS settings.
4450
* This does not offer any fixes but makes sure that all geometries are valid.
4551
*

‎src/analysis/vector/geometry_checker/qgssinglegeometrycheck.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ class QgsSingleGeometryCheck;
3939
class ANALYSIS_EXPORT QgsSingleGeometryCheckError
4040
{
4141
public:
42+
43+
/**
44+
* Creates a new single geometry check error.
45+
*/
4246
QgsSingleGeometryCheckError( const QgsSingleGeometryCheck *check, const QgsGeometry &geometry, const QgsGeometry &errorLocation, const QgsVertexId &vertexId = QgsVertexId() )
4347
: mCheck( check )
4448
, mGeometry( geometry )
@@ -111,6 +115,10 @@ class ANALYSIS_EXPORT QgsSingleGeometryCheckError
111115
class ANALYSIS_EXPORT QgsGeometryCheckErrorSingle : public QgsGeometryCheckError
112116
{
113117
public:
118+
119+
/**
120+
* Creates a new error for a QgsSingleGeometryCheck.
121+
*/
114122
QgsGeometryCheckErrorSingle( QgsSingleGeometryCheckError *singleError, const QgsGeometryCheckerUtils::LayerFeature &layerFeature );
115123

116124
/**

0 commit comments

Comments
 (0)
Please sign in to comment.