Skip to content

Commit d3f64de

Browse files
m-kuhnm-kuhn
committedDec 22, 2018
Further doc improvements
·
ltr-3_40final-3_6_0
1 parent 265df93 commit d3f64de

File tree

6 files changed

+68
-3
lines changed

6 files changed

+68
-3
lines changed
 

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ Returns the context
164164
protected:
165165

166166

167+
168+
169+
170+
167171
};
168172

169173
/************************************************************************

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010

1111

1212

13-
1413
class QgsGeometryCheckerUtils
1514
{
1615
%Docstring
@@ -28,8 +27,16 @@ Contains utilities required for geometry checks.
2827
#include "qgsgeometrycheckerutils.h"
2928
%End
3029
public:
30+
3131
class LayerFeature
3232
{
33+
%Docstring
34+
35+
A layer feature combination to uniquely identify and access a feature in
36+
a set of layers.
37+
38+
.. versionadded:: 3.4
39+
%End
3340

3441
%TypeHeaderCode
3542
#include "qgsgeometrycheckerutils.h"
@@ -79,6 +86,12 @@ Returns if the geometry is reprojected to the map CRS or not.
7986

8087
class LayerFeatures
8188
{
89+
%Docstring
90+
91+
Contains a set of layers and feature ids in those layers to pass to a geometry check.
92+
93+
.. versionadded:: 3.4
94+
%End
8295

8396
%TypeHeaderCode
8497
#include "qgsgeometrycheckerutils.h"

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,14 +253,48 @@ class ANALYSIS_EXPORT QgsGeometryCheck
253253
const QgsGeometryCheckContext *context() const { return mContext; }
254254

255255
protected:
256+
257+
/**
258+
* Returns all layers and feature ids.
259+
*
260+
* \since QGIS 3.4
261+
* \note Not available in Python bindings
262+
*/
256263
QMap<QString, QgsFeatureIds> allLayerFeatureIds( const QMap<QString, QgsFeaturePool *> &featurePools ) const SIP_SKIP;
264+
265+
/**
266+
* Replaces a part in a feature geometry.
267+
*
268+
* \since QGIS 3.4
269+
* \note Not available in Python bindings
270+
*/
257271
void replaceFeatureGeometryPart( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, QgsAbstractGeometry *newPartGeom, Changes &changes ) const SIP_SKIP;
272+
273+
/**
274+
* Deletes a part of a feature geometry.
275+
*
276+
* \since QGIS 3.4
277+
* \note Not available in Python bindings
278+
*/
258279
void deleteFeatureGeometryPart( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, Changes &changes ) const SIP_SKIP;
280+
281+
/**
282+
* Deletes a ring in a feature geometry.
283+
*
284+
* \since QGIS 3.4
285+
* \note Not available in Python bindings
286+
*/
259287
void deleteFeatureGeometryRing( const QMap<QString, QgsFeaturePool *> &featurePools, const QString &layerId, QgsFeature &feature, int partIdx, int ringIdx, Changes &changes ) const SIP_SKIP;
260288

261289
const QgsGeometryCheckContext *mContext;
262290
QVariantMap mConfiguration;
263291

292+
/**
293+
* Determin the scale factor of a layer to the map coordiante reference system.
294+
*
295+
* \since QGIS 3.4
296+
* \note Not available in Python bindings
297+
*/
264298
double scaleFactor( const QPointer<QgsVectorLayer> &layer ) const SIP_SKIP;
265299
};
266300

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ class QgsFeedback;
3939
class ANALYSIS_EXPORT QgsGeometryCheckerUtils
4040
{
4141
public:
42+
4243
/**
4344
* \ingroup analysis
4445
*
@@ -128,7 +129,7 @@ class ANALYSIS_EXPORT QgsGeometryCheckerUtils
128129
* \ingroup analysis
129130
*
130131
* An iterator over all features in a QgsGeometryCheckerUtils::LayerFeatures.
131-
*
132+
*
132133
* \since QGIS 3.4
133134
*/
134135
class iterator

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ email : matthias@opengis.ch
2020

2121
#include "qgssinglegeometrycheck.h"
2222

23+
/**
24+
* \ingroup analysis
25+
*
26+
* An error for a QgsGeometryIsValid check.
27+
* The description is delivered by the underlying check engine, either GEOS or QGIS internal.
28+
*
29+
* \since QGIS 3.4
30+
*/
2331
class ANALYSIS_EXPORT QgsGeometryIsValidCheckError : public QgsSingleGeometryCheckError
2432
{
2533
public:
@@ -40,6 +48,10 @@ class ANALYSIS_EXPORT QgsGeometryIsValidCheckError : public QgsSingleGeometryChe
4048
class ANALYSIS_EXPORT QgsGeometryIsValidCheck : public QgsSingleGeometryCheck
4149
{
4250
public:
51+
52+
/**
53+
* Creates a new is valid check with the provided \a context. No options are supported in \a configuration.
54+
*/
4355
explicit QgsGeometryIsValidCheck( const QgsGeometryCheckContext *context, const QVariantMap &configuration );
4456

4557
QList<QgsWkbTypes::GeometryType> compatibleGeometryTypes() const override;

‎tests/code_layout/acceptable_missing_doc.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,8 @@
489489
"QgsGeometrySelfIntersectionCheck": ["QgsGeometrySelfIntersectionCheck(const QgsGeometryCheckContext *context, const QVariantMap &configuration=QVariantMap())", "ResolutionMethod"],
490490
"QgsGeometryContainedCheck": ["factoryDescription()", "factoryId()", "factoryCompatibleGeometryTypes()", "factoryIsCompatible(QgsVectorLayer *layer)", "ResolutionMethod", "factoryCheckType()", "QgsGeometryContainedCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)"],
491491
"QgsGeometryPointInPolygonCheck": ["factoryDescription()", "factoryId()", "factoryCompatibleGeometryTypes()", "factoryIsCompatible(QgsVectorLayer *layer)", "ResolutionMethod", "factoryCheckType()", "QgsGeometryPointInPolygonCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)"],
492-
"QgsGeometryDuplicateNodesCheck": ["factoryDescription()", "factoryId()", "factoryCompatibleGeometryTypes()", "factoryIsCompatible(QgsVectorLayer *layer)", "ResolutionMethod", "factoryCheckType()", "QgsGeometryDuplicateNodesCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)"]
492+
"QgsGeometryDuplicateNodesCheck": ["factoryDescription()", "factoryId()", "factoryCompatibleGeometryTypes()", "factoryIsCompatible(QgsVectorLayer *layer)", "ResolutionMethod", "factoryCheckType()", "QgsGeometryDuplicateNodesCheck(QgsGeometryCheckContext *context, const QVariantMap &configuration)"],
493+
"QgsGeometryChecker": ["getContext() const", "featurePools() const", "setMergeAttributeIndices(const QMap< QString, int > &mergeAttributeIndices)", "progressValue(int value)", "getChecks() const", "errorAdded(QgsGeometryCheckError *error)", "QgsGeometryChecker(const QList< QgsGeometryCheck * > &checks, QgsGeometryCheckContext *context, const QMap< QString, QgsFeaturePool * > &featurePools)", "fixError(QgsGeometryCheckError *error, int method, bool triggerRepaint=false)", "errorUpdated(QgsGeometryCheckError *error, bool statusChanged)", "execute(int *totalSteps=nullptr)", "getMessages() const"]
493494
}
494495

495496
ACCEPTABLE_MISSING_ADDED_NOTE = [

0 commit comments

Comments
 (0)
Please sign in to comment.