Skip to content

Commit

Permalink
Mark geometry API as non-stable
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Jun 26, 2015
1 parent d875011 commit 9170b99
Show file tree
Hide file tree
Showing 18 changed files with 66 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/core/geometry/qgsabstractgeometryv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ class QPainter;
* \class QgsVertexId
* \brief Utility class for identifying a unique vertex within a geometry.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
struct CORE_EXPORT QgsVertexId
{
Expand Down
1 change: 1 addition & 0 deletions src/core/geometry/qgscircularstringv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
* \class QgsCircularStringV2
* \brief Circular string geometry type
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsCircularStringV2: public QgsCurveV2
{
Expand Down
1 change: 1 addition & 0 deletions src/core/geometry/qgscompoundcurvev2.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
* \class QgsCompoundCurveV2
* \brief Compound curve geometry type
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsCompoundCurveV2: public QgsCurveV2
{
Expand Down
1 change: 1 addition & 0 deletions src/core/geometry/qgscurvepolygonv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ class QgsPolygonV2;
* \class QgsCurvePolygonV2
* \brief Curve polygon geometry type
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsCurvePolygonV2: public QgsSurfaceV2
{
Expand Down
1 change: 1 addition & 0 deletions src/core/geometry/qgsgeometrycollectionv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ email : marco.hugentobler at sourcepole dot com
* \class QgsGeometryCollectionV2
* \brief Geometry collection
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsGeometryCollectionV2: public QgsAbstractGeometryV2
{
Expand Down
1 change: 1 addition & 0 deletions src/core/geometry/qgsgeometryeditutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ class QgsVectorLayer;
* \class QgsGeometryEditUtils
* \brief Convenience functions for geometry editing
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class QgsGeometryEditUtils
{
Expand Down
7 changes: 7 additions & 0 deletions src/core/geometry/qgsgeometryengine.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ email : marco.hugentobler at sourcepole dot com

class QgsAbstractGeometryV2;


/**\ingroup core
* \class QgsGeometryEngine
* \brief Contains geometry relation and modification algorithms.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsGeometryEngine
{
public:
Expand Down
1 change: 1 addition & 0 deletions src/core/geometry/qgsgeometryfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ typedef QVector<QgsPolygon> QgsMultiPolygon;
* \class QgsGeometryFactory
* \brief Contains geometry creation routines.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsGeometryFactory
{
Expand Down
1 change: 1 addition & 0 deletions src/core/geometry/qgsgeometryutils.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ email : marco.hugentobler at sourcepole dot com
* \class QgsGeometryUtils
* \brief Contains various geometry utility functions.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsGeometryUtils
{
Expand Down
4 changes: 3 additions & 1 deletion src/core/geometry/qgsgeos.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ email : marco.hugentobler at sourcepole dot com
class QgsLineStringV2;
class QgsPolygonV2;

/**Does vector analysis using the geos library and handles import, export, exception handling*/
/** Does vector analysis using the geos library and handles import, export, exception handling*
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsGeos: public QgsGeometryEngine
{
public:
Expand Down
6 changes: 6 additions & 0 deletions src/core/geometry/qgslinestringv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@
#include "qgswkbptr.h"
#include <QPolygonF>

/**\ingroup core
* \class QgsLineStringV2
* \brief Line string geometry type.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsLineStringV2: public QgsCurveV2
{
public:
Expand Down
6 changes: 6 additions & 0 deletions src/core/geometry/qgsmulticurvev2.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ email : marco.hugentobler at sourcepole dot com

#include "qgsgeometrycollectionv2.h"

/**\ingroup core
* \class QgsMultiCurveV2
* \brief Multi curve geometry collection.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsMultiCurveV2: public QgsGeometryCollectionV2
{
public:
Expand Down
6 changes: 6 additions & 0 deletions src/core/geometry/qgsmultilinestringv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ email : marco.hugentobler at sourcepole dot com

#include "qgsmulticurvev2.h"

/**\ingroup core
* \class QgsMultiLineStringV2
* \brief Multi line string geometry collection.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsMultiLineStringV2: public QgsMultiCurveV2
{
public:
Expand Down
6 changes: 6 additions & 0 deletions src/core/geometry/qgsmultipointv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ email : marco.hugentobler at sourcepole dot com

#include "qgsgeometrycollectionv2.h"

/**\ingroup core
* \class QgsMultiPointV2
* \brief Multi point geometry collection.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsMultiPointV2: public QgsGeometryCollectionV2
{
public:
Expand Down
6 changes: 6 additions & 0 deletions src/core/geometry/qgsmultipolygonv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ email : marco.hugentobler at sourcepole dot com

#include "qgsmultisurfacev2.h"

/**\ingroup core
* \class QgsMultiPolygonV2
* \brief Multi polygon geometry collection.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsMultiPolygonV2: public QgsMultiSurfaceV2
{
public:
Expand Down
6 changes: 6 additions & 0 deletions src/core/geometry/qgsmultisurfacev2.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ email : marco.hugentobler at sourcepole dot com

#include "qgsgeometrycollectionv2.h"

/**\ingroup core
* \class QgsMultiSurfaceV2
* \brief Multi surface geometry collection.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsMultiSurfaceV2: public QgsGeometryCollectionV2
{
public:
Expand Down
6 changes: 6 additions & 0 deletions src/core/geometry/qgspointv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@

#include "qgsabstractgeometryv2.h"

/**\ingroup core
* \class QgsPointV2
* \brief Point geometry type.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsPointV2: public QgsAbstractGeometryV2
{
public:
Expand Down
6 changes: 6 additions & 0 deletions src/core/geometry/qgspolygonv2.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@

#include "qgscurvepolygonv2.h"

/**\ingroup core
* \class QgsPolygonV2
* \brief Polygon geometry type.
* \note added in QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsPolygonV2: public QgsCurvePolygonV2
{
public:
Expand Down

0 comments on commit 9170b99

Please sign in to comment.