Skip to content

Commit

Permalink
Even more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn committed Dec 22, 2018
1 parent bdedc86 commit 265df93
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 1 deletion.
3 changes: 3 additions & 0 deletions src/analysis/vector/geometry_checker/qgsgeometryareacheck.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@

class QgsSurface;

/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometryAreaCheck : public QgsGeometryCheck
{
public:
Expand Down
30 changes: 29 additions & 1 deletion src/analysis/vector/geometry_checker/qgsgeometrycheckerutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
#include "qgsvectorlayer.h"
#include "qgsgeometrycheckerror.h"

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

/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometryContainedCheck : public QgsGeometryCheck
{
public:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
class QgsSpatialIndex;


/**
* \ingroup analysis
*/
class ANALYSIS_EXPORT QgsGeometryFollowBoundariesCheck : public QgsGeometryCheck
{
public:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@

#include "qgsgeometrycheck.h"

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

0 comments on commit 265df93

Please sign in to comment.