dox++

qgis · Apr 29, 2021 · 0a48e80 · 0a48e80
1 parent 24dba98
commit 0a48e80
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 6 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in
@@ -747,7 +747,9 @@ Returns a weighted point inside the triangle denoted by the points (``aX``, ``aY
  static bool setZValueFromPoints( const QgsPointSequence &points, QgsPoint &point ) /Deprecated/;
 %Docstring
 A Z dimension is added to ``point`` if one of the point in the list
-``points`` is in 3D. Moreover, the Z value of ``point`` is updated with.
+``points`` is in 3D. Moreover, the Z value of ``point`` is updated
+with the first Z value found in list ``points`` even if ``point``
+already contains a Z value.
 
 :param points: List of points in which a 3D point is searched.
 :param point: The point to update with Z dimension and value.
@@ -769,7 +771,9 @@ A Z dimension is added to ``point`` if one of the point in the list
     static bool transferFirstZValueToPoint( const QgsPointSequence &points, QgsPoint &point );
 %Docstring
 A Z dimension is added to ``point`` if one of the point in the list
-``points`` is in 3D. Moreover, the Z value of ``point`` is updated with.
+``points`` is in 3D. Moreover, the Z value of ``point`` is updated
+with the first Z value found in list ``points`` even if ``point``
+already contains a Z value.
 
 :param points: List of points in which a 3D point is searched.
 :param point: The point to update with Z dimension and value.
@@ -789,7 +793,8 @@ A Z dimension is added to ``point`` if one of the point in the list
 %Docstring
 A M dimension is added to ``point`` if one of the points in the list
 ``points`` contains an M value. Moreover, the M value of ``point`` is
-updated with the first M value found in list ``points``.
+updated with the first M value found in list ``points`` even if ``point``
+already contains a M value.
 
 :param points: List of points in which a M point is searched.
 :param point: The point to update with M dimension and value.

diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h
@@ -770,7 +770,9 @@ class CORE_EXPORT QgsGeometryUtils
 
     /**
      * A Z dimension is added to \a point if one of the point in the list
-     * \a points is in 3D. Moreover, the Z value of \a point is updated with.
+     * \a points is in 3D. Moreover, the Z value of \a point is updated
+     * with the first Z value found in list \a points even if \a point
+     * already contains a Z value.
      *
      * \param points List of points in which a 3D point is searched.
      * \param point The point to update with Z dimension and value.
@@ -789,7 +791,9 @@ class CORE_EXPORT QgsGeometryUtils
 
     /**
      * A Z dimension is added to \a point if one of the point in the list
-     * \a points is in 3D. Moreover, the Z value of \a point is updated with.
+     * \a points is in 3D. Moreover, the Z value of \a point is updated
+     * with the first Z value found in list \a points even if \a point
+     * already contains a Z value.
      *
      * \param points List of points in which a 3D point is searched.
      * \param point The point to update with Z dimension and value.
@@ -805,7 +809,8 @@ class CORE_EXPORT QgsGeometryUtils
     /**
      * A M dimension is added to \a point if one of the points in the list
      * \a points contains an M value. Moreover, the M value of \a point is
-     * updated with the first M value found in list \a points.
+     * updated with the first M value found in list \a points even if \a point
+     * already contains a M value.
      *
      * \param points List of points in which a M point is searched.
      * \param point The point to update with M dimension and value.