From 2768e41f0a92e6c9bbfa5f154cff060b6fafa06d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Germ=C3=A1n=20Carrillo?= Date: Thu, 23 May 2024 15:11:44 -0500 Subject: [PATCH] Adjust docstring in qgsgeometryutils_base.h --- .../core/auto_generated/geometry/qgsgeometryutils_base.sip.in | 4 ++-- .../core/auto_generated/geometry/qgsgeometryutils_base.sip.in | 4 ++-- src/core/geometry/qgsgeometryutils_base.h | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in index c9f8dcb47d26..64855923961e 100644 --- a/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in +++ b/python/PyQt6/core/auto_generated/geometry/qgsgeometryutils_base.sip.in @@ -23,7 +23,7 @@ Convenience functions for geometry utils. static double sqrDistance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) /HoldGIL/; %Docstring -Returns the squared 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (``z2``, ``z2``). +Returns the squared 3D distance between (``x1``, ``y1``, ``z1``) and (``x2``, ``y2``, ``z2``). .. warning:: @@ -34,7 +34,7 @@ Returns the squared 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and ( static double distance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) /HoldGIL/; %Docstring -Returns the 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (``z2``, ``z2``). +Returns the 3D distance between (``x1``, ``y1``, ``z1``) and (``x2``, ``y2``, ``z2``). .. warning:: diff --git a/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in index c9f8dcb47d26..64855923961e 100644 --- a/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometryutils_base.sip.in @@ -23,7 +23,7 @@ Convenience functions for geometry utils. static double sqrDistance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) /HoldGIL/; %Docstring -Returns the squared 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (``z2``, ``z2``). +Returns the squared 3D distance between (``x1``, ``y1``, ``z1``) and (``x2``, ``y2``, ``z2``). .. warning:: @@ -34,7 +34,7 @@ Returns the squared 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and ( static double distance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) /HoldGIL/; %Docstring -Returns the 3D distance between (``x1``, ``y1``), (``x2``, ``y2``) and (``z2``, ``z2``). +Returns the 3D distance between (``x1``, ``y1``, ``z1``) and (``x2``, ``y2``, ``z2``). .. warning:: diff --git a/src/core/geometry/qgsgeometryutils_base.h b/src/core/geometry/qgsgeometryutils_base.h index ca7c22b9e832..d9884dddc5fb 100644 --- a/src/core/geometry/qgsgeometryutils_base.h +++ b/src/core/geometry/qgsgeometryutils_base.h @@ -32,7 +32,7 @@ class CORE_EXPORT QgsGeometryUtilsBase public: /** - * Returns the squared 3D distance between (\a x1, \a y1), (\a x2, \a y2) and (\a z2, \a z2). + * Returns the squared 3D distance between (\a x1, \a y1, \a z1) and (\a x2, \a y2, \a z2). * * \warning No check is done if z contains NaN value. This is the caller's responsibility. * \since QGIS 3.36 @@ -40,7 +40,7 @@ class CORE_EXPORT QgsGeometryUtilsBase static double sqrDistance3D( double x1, double y1, double z1, double x2, double y2, double z2 ) SIP_HOLDGIL {return ( x1 - x2 ) * ( x1 - x2 ) + ( y1 - y2 ) * ( y1 - y2 ) + ( z1 - z2 ) * ( z1 - z2 ); } /** - * Returns the 3D distance between (\a x1, \a y1), (\a x2, \a y2) and (\a z2, \a z2). + * Returns the 3D distance between (\a x1, \a y1, \a z1) and (\a x2, \a y2, \a z2). * * \warning No check is done if z contains NaN value. This is the caller's responsibility. * \since QGIS 3.36