Dox ++

qgis · Apr 27, 2021 · bab01b1 · bab01b1
1 parent a9ba935
commit bab01b1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git 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
@@ -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;