Adjust docstring in qgsgeometryutils_base.h

This commit is contained in:
Germán Carrillo 2024-05-23 15:11:44 -05:00 committed by Nyall Dawson
parent 91a5382d81
commit 2768e41f0a
3 changed files with 6 additions and 6 deletions

View File

@ -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::

View File

@ -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::

View File

@ -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