From bab01b1b757ee36700a7d9a3f4da970c952025fb Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Tue, 27 Apr 2021 17:59:10 +1000 Subject: [PATCH] Dox ++ --- .../core/auto_generated/geometry/qgsabstractgeometry.sip.in | 6 ++++++ src/core/geometry/qgsabstractgeometry.h | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in b/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in index 989fea249e5..48aa61dcde8 100644 --- a/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in +++ b/python/core/auto_generated/geometry/qgsabstractgeometry.sip.in @@ -829,6 +829,12 @@ geometries of different types. Compares to an ``other`` geometry of the same class, and returns a integer for sorting of the two geometries. +.. note:: + + The actual logic for the sorting is an internal detail only and is subject to change + between QGIS versions. The result should only be used for direct comparison of geometries + and not stored for later use. + .. versionadded:: 3.20 %End diff --git a/src/core/geometry/qgsabstractgeometry.h b/src/core/geometry/qgsabstractgeometry.h index 8d1dae87b5f..ba7130e3e1f 100644 --- a/src/core/geometry/qgsabstractgeometry.h +++ b/src/core/geometry/qgsabstractgeometry.h @@ -1045,6 +1045,10 @@ class CORE_EXPORT QgsAbstractGeometry * Compares to an \a other geometry of the same class, and returns a integer * for sorting of the two geometries. * + * \note The actual logic for the sorting is an internal detail only and is subject to change + * between QGIS versions. The result should only be used for direct comparison of geometries + * and not stored for later use. + * * \since QGIS 3.20 */ virtual int compareToSameClass( const QgsAbstractGeometry *other ) const = 0;