sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-24 00:05:18 -05:00
Code Issues Packages Projects Releases Wiki Activity

QgsAbstractGeometry: Update dox for fuzzyEqual and fix \see tags

Browse Source
This commit is contained in:
Loïc Bartoletti 2024-01-11 10:16:51 +01:00 committed by Nyall Dawson
parent c16938c683
commit 7bdf16d976
3 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
python/PyQt6/core/auto_generated/geometry/qgsabstractgeometry.sip.in
View File

@ -103,9 +103,11 @@ Constructor for QgsAbstractGeometry.
%Docstring
Performs fuzzy comparison between this geometry and ``other`` using an ``epsilon``.
The comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.
.. seealso:: :py:func:`fuzzyDistanceEqual`
.. seealso:: :py:func:`QgsGeometryUtilsBase.fuzzyEqual`
.. seealso:: :py:func:`QgsGeometryUtilsBase.fuzzyDistanceEqual`
.. versionadded:: 3.36
%End
@ -114,14 +116,14 @@ Performs fuzzy comparison between this geometry and ``other`` using an ``epsilon
%Docstring
Performs fuzzy distance comparison between this geometry and ``other`` using an ``epsilon``.
Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of points.
Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.
It focuses on the numerical differences or relationships between these values.
On the other hand, comparing distances between points considers the actual spatial separation or length between the points, regardless of their coordinate values.
This comparison involves measuring the distance between two points using formulas like the distance formula. Here, it's the "distance comparison" (fuzzyDistanceEqual).
.. seealso:: :py:func:`fuzzyEqual`
.. seealso:: :py:func:`QgsGeometryUtilsBase.fuzzyDistanceEqual`
.. seealso:: :py:func:`QgsGeometryUtilsBase.fuzzyEqual`
.. versionadded:: 3.36
%End

8
python/core/auto_generated/geometry/qgsabstractgeometry.sip.in
View File

@ -103,9 +103,11 @@ Constructor for QgsAbstractGeometry.
%Docstring
Performs fuzzy comparison between this geometry and ``other`` using an ``epsilon``.
The comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.
.. seealso:: :py:func:`fuzzyDistanceEqual`
.. seealso:: :py:func:`QgsGeometryUtilsBase.fuzzyEqual`
.. seealso:: :py:func:`QgsGeometryUtilsBase.fuzzyDistanceEqual`
.. versionadded:: 3.36
%End
@ -114,14 +116,14 @@ Performs fuzzy comparison between this geometry and ``other`` using an ``epsilon
%Docstring
Performs fuzzy distance comparison between this geometry and ``other`` using an ``epsilon``.
Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of points.
Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.
It focuses on the numerical differences or relationships between these values.
On the other hand, comparing distances between points considers the actual spatial separation or length between the points, regardless of their coordinate values.
This comparison involves measuring the distance between two points using formulas like the distance formula. Here, it's the "distance comparison" (fuzzyDistanceEqual).
.. seealso:: :py:func:`fuzzyEqual`
.. seealso:: :py:func:`QgsGeometryUtilsBase.fuzzyDistanceEqual`
.. seealso:: :py:func:`QgsGeometryUtilsBase.fuzzyEqual`
.. versionadded:: 3.36
%End

8
src/core/geometry/qgsabstractgeometry.h
View File

@ -165,8 +165,10 @@ class CORE_EXPORT QgsAbstractGeometry
/**
* Performs fuzzy comparison between this geometry and \a other using an \a epsilon.
*
* The comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.
*
* \see fuzzyDistanceEqual
* \see QgsGeometryUtilsBase::fuzzyEqual
* \see QgsGeometryUtilsBase::fuzzyDistanceEqual
*
* \since QGIS 3.36
*/
@ -175,13 +177,13 @@ class CORE_EXPORT QgsAbstractGeometry
/**
* Performs fuzzy distance comparison between this geometry and \a other using an \a epsilon.
*
* Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of points.
* Traditionally, the comparison is done by examining the specific values (such as x and y) that define the location of vertices in the geometry.
* It focuses on the numerical differences or relationships between these values.
* On the other hand, comparing distances between points considers the actual spatial separation or length between the points, regardless of their coordinate values.
* This comparison involves measuring the distance between two points using formulas like the distance formula. Here, it's the "distance comparison" (fuzzyDistanceEqual).
*
* \see fuzzyEqual
* \see QgsGeometryUtilsBase::fuzzyDistanceEqual
* \see QgsGeometryUtilsBase::fuzzyEqual
*
* \since QGIS 3.36
*/