Mark geometry API as non-stable

nyalldawson · nyalldawson · commit 9170b992b159 · 2015-06-26T10:32:22.000+10:00
diff --git a/src/core/geometry/qgsabstractgeometryv2.h b/src/core/geometry/qgsabstractgeometryv2.h
@@ -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
 {
diff --git a/src/core/geometry/qgscircularstringv2.h b/src/core/geometry/qgscircularstringv2.h
@@ -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
 {
diff --git a/src/core/geometry/qgscompoundcurvev2.h b/src/core/geometry/qgscompoundcurvev2.h
@@ -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
 {
diff --git a/src/core/geometry/qgscurvepolygonv2.h b/src/core/geometry/qgscurvepolygonv2.h
@@ -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
 {
diff --git a/src/core/geometry/qgsgeometrycollectionv2.h b/src/core/geometry/qgsgeometrycollectionv2.h
@@ -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
 {
diff --git a/src/core/geometry/qgsgeometryeditutils.h b/src/core/geometry/qgsgeometryeditutils.h
@@ -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
 {
diff --git a/src/core/geometry/qgsgeometryengine.h b/src/core/geometry/qgsgeometryengine.h
@@ -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:
diff --git a/src/core/geometry/qgsgeometryfactory.h b/src/core/geometry/qgsgeometryfactory.h
@@ -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
 {
diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h
@@ -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
 {
diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h
@@ -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:
diff --git a/src/core/geometry/qgslinestringv2.h b/src/core/geometry/qgslinestringv2.h
@@ -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:
diff --git a/src/core/geometry/qgsmulticurvev2.h b/src/core/geometry/qgsmulticurvev2.h
@@ -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:
diff --git a/src/core/geometry/qgsmultilinestringv2.h b/src/core/geometry/qgsmultilinestringv2.h
@@ -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:
diff --git a/src/core/geometry/qgsmultipointv2.h b/src/core/geometry/qgsmultipointv2.h
@@ -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:
diff --git a/src/core/geometry/qgsmultipolygonv2.h b/src/core/geometry/qgsmultipolygonv2.h
@@ -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:
diff --git a/src/core/geometry/qgsmultisurfacev2.h b/src/core/geometry/qgsmultisurfacev2.h
@@ -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:
diff --git a/src/core/geometry/qgspointv2.h b/src/core/geometry/qgspointv2.h
@@ -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:
diff --git a/src/core/geometry/qgspolygonv2.h b/src/core/geometry/qgspolygonv2.h
@@ -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:

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ class QPainter;`
`34`	`34`	`* \class QgsVertexId`
`35`	`35`	`* \brief Utility class for identifying a unique vertex within a geometry.`
`36`	`36`	`* \note added in QGIS 2.10`
	`37`	`+ * \note this API is not considered stable and may change for 2.12`
`37`	`38`	`*/`
`38`	`39`	`struct CORE_EXPORT QgsVertexId`
`39`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`* \class QgsCircularStringV2`
`26`	`26`	`* \brief Circular string geometry type`
`27`	`27`	`* \note added in QGIS 2.10`
	`28`	`+ * \note this API is not considered stable and may change for 2.12`
`28`	`29`	`*/`
`29`	`30`	`class CORE_EXPORT QgsCircularStringV2: public QgsCurveV2`
`30`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`* \class QgsCompoundCurveV2`
`25`	`25`	`* \brief Compound curve geometry type`
`26`	`26`	`* \note added in QGIS 2.10`
	`27`	`+ * \note this API is not considered stable and may change for 2.12`
`27`	`28`	`*/`
`28`	`29`	`class CORE_EXPORT QgsCompoundCurveV2: public QgsCurveV2`
`29`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ class QgsPolygonV2;`
`26`	`26`	`* \class QgsCurvePolygonV2`
`27`	`27`	`* \brief Curve polygon geometry type`
`28`	`28`	`* \note added in QGIS 2.10`
	`29`	`+ * \note this API is not considered stable and may change for 2.12`
`29`	`30`	`*/`
`30`	`31`	`class CORE_EXPORT QgsCurvePolygonV2: public QgsSurfaceV2`
`31`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ email : marco.hugentobler at sourcepole dot com`
`23`	`23`	`* \class QgsGeometryCollectionV2`
`24`	`24`	`* \brief Geometry collection`
`25`	`25`	`* \note added in QGIS 2.10`
	`26`	`+ * \note this API is not considered stable and may change for 2.12`
`26`	`27`	`*/`
`27`	`28`	`class CORE_EXPORT QgsGeometryCollectionV2: public QgsAbstractGeometryV2`
`28`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ class QgsVectorLayer;`
`28`	`28`	`* \class QgsGeometryEditUtils`
`29`	`29`	`* \brief Convenience functions for geometry editing`
`30`	`30`	`* \note added in QGIS 2.10`
	`31`	`+ * \note this API is not considered stable and may change for 2.12`
`31`	`32`	`*/`
`32`	`33`	`class QgsGeometryEditUtils`
`33`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ typedef QVector<QgsPolygon> QgsMultiPolygon;`
`37`	`37`	`* \class QgsGeometryFactory`
`38`	`38`	`* \brief Contains geometry creation routines.`
`39`	`39`	`* \note added in QGIS 2.10`
	`40`	`+ * \note this API is not considered stable and may change for 2.12`
`40`	`41`	`*/`
`41`	`42`	`class CORE_EXPORT QgsGeometryFactory`
`42`	`43`	`{`