Skip to content
Permalink
Browse files

Even more docs

  • Loading branch information
m-kuhn committed Dec 22, 2018
1 parent bdedc86 commit 265df937691856c29a688142b4425e5cc09c9c4f
@@ -22,6 +22,9 @@

class QgsSurface;

/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometryAreaCheck : public QgsGeometryCheck
{
public:
@@ -36,10 +36,17 @@ class QgsFeedback;
* \note This class is a technology preview and unstable API.
* \since QGIS 3.4
*/

class ANALYSIS_EXPORT QgsGeometryCheckerUtils
{
public:
/**
* \ingroup analysis
*
* A layer feature combination to uniquely identify and access a feature in
* a set of layers.
*
* \since QGIS 3.4
*/
class ANALYSIS_EXPORT LayerFeature
{
public:
@@ -94,6 +101,13 @@ class ANALYSIS_EXPORT QgsGeometryCheckerUtils
bool mMapCrs;
};

/**
* \ingroup analysis
*
* Contains a set of layers and feature ids in those layers to pass to a geometry check.
*
* \since QGIS 3.4
*/
class ANALYSIS_EXPORT LayerFeatures
{
public:
@@ -110,6 +124,13 @@ class ANALYSIS_EXPORT QgsGeometryCheckerUtils
const QList<QgsWkbTypes::GeometryType> &geometryTypes,
const QgsGeometryCheckContext *context );

/**
* \ingroup analysis
*
* An iterator over all features in a QgsGeometryCheckerUtils::LayerFeatures.
*
* \since QGIS 3.4
*/
class iterator
{
public:
@@ -131,7 +152,14 @@ class ANALYSIS_EXPORT QgsGeometryCheckerUtils
std::unique_ptr<QgsGeometryCheckerUtils::LayerFeature> mCurrentFeature;
};

/**
* The first feature to start iterating.
*/
iterator begin() const;

/**
* One after the last feature to stop iterating.
*/
iterator end() const;

#endif
@@ -22,6 +22,9 @@
#include "qgsvectorlayer.h"
#include "qgsgeometrycheckerror.h"

/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometryContainedCheckError : public QgsGeometryCheckError
{
public:
@@ -46,6 +49,9 @@ class ANALYSIS_EXPORT QgsGeometryContainedCheckError : public QgsGeometryCheckEr
QPair<QString, QgsFeatureId> mContainingFeature;
};

/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometryContainedCheck : public QgsGeometryCheck
{
public:
@@ -23,6 +23,9 @@
class QgsSpatialIndex;


/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometryFollowBoundariesCheck : public QgsGeometryCheck
{
public:
@@ -20,6 +20,9 @@

#include "qgsgeometrycheck.h"

/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometrySegmentLengthCheck : public QgsGeometryCheck
{
public:

0 comments on commit 265df93

Please sign in to comment.
You can’t perform that action at this time.