Dox++

qgis · May 4, 2021 · 2f77f6f · 2f77f6f
1 parent e9a0ecd
commit 2f77f6f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 18 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -566,14 +566,14 @@ In case of error -1 will be returned.
 
     double frechetDistance( const QgsGeometry &geom ) const throw( QgsNotSupportedException );
 %Docstring
-Returns the Fréchet distance this geometry and ``geom``, restricted to discrete points for both geometries.
+Returns the Fréchet distance between this geometry and ``geom``, restricted to discrete points for both geometries.
 
 The Fréchet distance is a measure of similarity between curves that takes into account the location and ordering of the points along the curves.
 Therefore it is often better than the Hausdorff distance.
 
 In case of error -1 will be returned.
 
-This method requires QGIS builds based on GEOS 3.7 or later.
+This method requires a QGIS build based on GEOS 3.7 or later.
 
 :raises :: py:class:`QgsNotSupportedException` on QGIS builds based on GEOS 3.6 or earlier.
 
@@ -584,7 +584,7 @@ This method requires QGIS builds based on GEOS 3.7 or later.
 
     double frechetDistanceDensify( const QgsGeometry &geom, double densifyFraction ) const throw( QgsNotSupportedException );
 %Docstring
-Returns the Fréchet distance this geometry and ``geom``, restricted to discrete points for both geometries.
+Returns the Fréchet distance between this geometry and ``geom``, restricted to discrete points for both geometries.
 
 The Fréchet distance is a measure of similarity between curves that takes into account the location and ordering of the points along the curves.
 Therefore it is often better than the Hausdorff distance.
@@ -599,7 +599,7 @@ This method can be used when the default approximation provided by :py:func:`~Qg
 is not sufficient. Decreasing the ``densifyFraction`` parameter will make the
 distance returned approach the true Fréchet distance for the geometries.
 
-This method requires QGIS builds based on GEOS 3.7 or later.
+This method requires a QGIS build based on GEOS 3.7 or later.
 
 :raises :: py:class:`QgsNotSupportedException` on QGIS builds based on GEOS 3.6 or earlier.
 
@@ -1423,7 +1423,7 @@ contains the geometry, where a band is a strip of the plane defined
 by two parallel lines. This can be thought of as the smallest hole that the geometry
 can be moved through, with a single rotation.
 
-This method requires QGIS builds based on GEOS 3.6 or later.
+This method requires a QGIS build based on GEOS 3.6 or later.
 
 :raises :: py:class:`QgsNotSupportedException` on QGIS builds based on GEOS 3.5 or earlier.
 
@@ -1435,18 +1435,18 @@ This method requires QGIS builds based on GEOS 3.6 or later.
 Computes the minimum clearance of a geometry.
 
 The minimum clearance is the smallest amount by which
-a vertex could be move to produce an invalid polygon, a non-simple linestring, or a multipoint with
+a vertex could be moved to produce an invalid polygon, a non-simple linestring, or a multipoint with
 repeated points.  If a geometry has a minimum clearance of 'eps', it can be said that:
 
 - No two distinct vertices in the geometry are separated by less than 'eps'
 - No vertex is closer than 'eps' to a line segment of which it is not an endpoint.
 
 If the minimum clearance cannot be defined for a geometry (such as with a single point, or a multipoint
-whose points are identical, a value of Infinity will be calculated.
+whose points are identical) a value of infinity will be returned.
 
 If an error occurs while calculating the clearance NaN will be returned.
 
-This method requires QGIS builds based on GEOS 3.6 or later.
+This method requires a QGIS build based on GEOS 3.6 or later.
 
 :raises :: py:class:`QgsNotSupportedException` on QGIS builds based on GEOS 3.5 or earlier.
 
@@ -1459,7 +1459,7 @@ Returns a LineString whose endpoints define the minimum clearance of a geometry.
 
 If the geometry has no minimum clearance, an empty LineString will be returned.
 
-This method requires QGIS builds based on GEOS 3.6 or later.
+This method requires a QGIS build based on GEOS 3.6 or later.
 
 :raises :: py:class:`QgsNotSupportedException` on QGIS builds based on GEOS 3.5 or earlier.
 

diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -640,14 +640,14 @@ class CORE_EXPORT QgsGeometry
     double hausdorffDistanceDensify( const QgsGeometry &geom, double densifyFraction ) const;
 
     /**
-     * Returns the Fréchet distance this geometry and \a geom, restricted to discrete points for both geometries.
+     * Returns the Fréchet distance between this geometry and \a geom, restricted to discrete points for both geometries.
      *
      * The Fréchet distance is a measure of similarity between curves that takes into account the location and ordering of the points along the curves.
      * Therefore it is often better than the Hausdorff distance.
      *
      * In case of error -1 will be returned.
      *
-     * This method requires QGIS builds based on GEOS 3.7 or later.
+     * This method requires a QGIS build based on GEOS 3.7 or later.
      *
      * \throws QgsNotSupportedException on QGIS builds based on GEOS 3.6 or earlier.
      * \see frechetDistanceDensify()
@@ -656,7 +656,7 @@ class CORE_EXPORT QgsGeometry
     double frechetDistance( const QgsGeometry &geom ) const SIP_THROW( QgsNotSupportedException );
 
     /**
-     * Returns the Fréchet distance this geometry and \a geom, restricted to discrete points for both geometries.
+     * Returns the Fréchet distance between this geometry and \a geom, restricted to discrete points for both geometries.
      *
      * The Fréchet distance is a measure of similarity between curves that takes into account the location and ordering of the points along the curves.
      * Therefore it is often better than the Hausdorff distance.
@@ -671,7 +671,7 @@ class CORE_EXPORT QgsGeometry
      * is not sufficient. Decreasing the \a densifyFraction parameter will make the
      * distance returned approach the true Fréchet distance for the geometries.
      *
-     * This method requires QGIS builds based on GEOS 3.7 or later.
+     * This method requires a QGIS build based on GEOS 3.7 or later.
      *
      * \throws QgsNotSupportedException on QGIS builds based on GEOS 3.6 or earlier.
      * \see frechetDistance()
@@ -1425,7 +1425,7 @@ class CORE_EXPORT QgsGeometry
      * by two parallel lines. This can be thought of as the smallest hole that the geometry
      * can be moved through, with a single rotation.
      *
-     * This method requires QGIS builds based on GEOS 3.6 or later.
+     * This method requires a QGIS build based on GEOS 3.6 or later.
      *
      * \throws QgsNotSupportedException on QGIS builds based on GEOS 3.5 or earlier.
      *
@@ -1437,18 +1437,18 @@ class CORE_EXPORT QgsGeometry
      * Computes the minimum clearance of a geometry.
      *
      * The minimum clearance is the smallest amount by which
-     * a vertex could be move to produce an invalid polygon, a non-simple linestring, or a multipoint with
+     * a vertex could be moved to produce an invalid polygon, a non-simple linestring, or a multipoint with
      * repeated points.  If a geometry has a minimum clearance of 'eps', it can be said that:
      *
      * - No two distinct vertices in the geometry are separated by less than 'eps'
      * - No vertex is closer than 'eps' to a line segment of which it is not an endpoint.
      *
      * If the minimum clearance cannot be defined for a geometry (such as with a single point, or a multipoint
-     * whose points are identical, a value of Infinity will be calculated.
+     * whose points are identical) a value of infinity will be returned.
      *
      * If an error occurs while calculating the clearance NaN will be returned.
      *
-     * This method requires QGIS builds based on GEOS 3.6 or later.
+     * This method requires a QGIS build based on GEOS 3.6 or later.
      *
      * \throws QgsNotSupportedException on QGIS builds based on GEOS 3.5 or earlier.
      *
@@ -1461,7 +1461,7 @@ class CORE_EXPORT QgsGeometry
      *
      * If the geometry has no minimum clearance, an empty LineString will be returned.
      *
-     * This method requires QGIS builds based on GEOS 3.6 or later.
+     * This method requires a QGIS build based on GEOS 3.6 or later.
      *
      * \throws QgsNotSupportedException on QGIS builds based on GEOS 3.5 or earlier.
      *