[geos-commits] [SCM] GEOS branch main updated. 7666268c905bbc2fe5c22ce7745c6b9e24519eb7

[git at osgeo.org]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GEOS".

The branch, main has been updated
       via  7666268c905bbc2fe5c22ce7745c6b9e24519eb7 (commit)
       via  f97a996cf50984051e3a0d36baf9b14e56004086 (commit)
      from  4dc426119d3fbbc85f42c2cf0613d1a7d001190d (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 7666268c905bbc2fe5c22ce7745c6b9e24519eb7
Author: Martin Davis <mtnclimb at gmail.com>
Date:   Mon Apr 17 21:54:20 2023 -0700

    C API doc formatting

diff --git a/capi/geos_c.h.in b/capi/geos_c.h.in
index e8ef1fed9..cef509caa 100644
--- a/capi/geos_c.h.in
+++ b/capi/geos_c.h.in
@@ -5129,7 +5129,7 @@ extern void GEOS_DLL GEOSSTRtree_insert(
 * \param callback a function to be executed for each item in the tree whose envelope intersects
 *            the envelope of 'g'.  The callback function should take two parameters: a void
 *            pointer representing the located item in the tree, and a void userdata pointer.
-* \param userdata an optional pointer to pe passed to 'callback' as an argument
+* \param userdata an optional pointer to pe passed to `callback` as an argument
 *
 * \since 3.2
 */
@@ -5168,11 +5168,11 @@ extern const GEOSGeometry GEOS_DLL *GEOSSTRtree_nearest(
 * \param distancefn a function that can compute the distance between two items
 *            in the STRtree.  The function should return zero in case of error,
 *            and should store the computed distance to the location pointed to by
-*            the 'distance' argument.  The computed distance between two items
+*            the `distance` argument.  The computed distance between two items
 *            must not exceed the Cartesian distance between their envelopes.
-* \param userdata optional pointer to arbitrary data; will be passed to distancefn
+* \param userdata optional pointer to arbitrary data; will be passed to `distancefn`
 *            each time it is called.
-* \return a const pointer to the nearest item in the tree to 'item', or NULL in
+* \return a const pointer to the nearest item in the tree to `item`, or NULL in
 *            case of exception
 *
 * \since 3.6

commit f97a996cf50984051e3a0d36baf9b14e56004086
Author: Martin Davis <mtnclimb at gmail.com>
Date:   Mon Apr 17 16:33:42 2023 -0700

    Minor C API doc improvements

diff --git a/capi/geos_c.h.in b/capi/geos_c.h.in
index 53ff9bc70..e8ef1fed9 100644
--- a/capi/geos_c.h.in
+++ b/capi/geos_c.h.in
@@ -97,7 +97,7 @@ typedef struct GEOSContextHandle_HS *GEOSContextHandle_t;
 /**
 * Callback function for passing GEOS error messages to parent process.
 *
-* Set the GEOSMessageHandler for error and notice messages in \ref initGEOS
+* Set the \ref GEOSMessageHandler function for error and notice messages in \ref initGEOS
 * for single-threaded programs, or using \ref initGEOS_r for threaded
 * programs
 *
@@ -127,10 +127,10 @@ typedef void (*GEOSMessageHandler_r)(const char *message, void *userdata);
 #ifndef GEOSGeometry
 
 /**
-* Geometry generic type. Geometry can be a point, linestring, polygon,
-* multipoint, multilinestring, multipolygon, or geometrycollection.
-* Geometry type can be read with \ref GEOSGeomTypeId. Most functions
-* in GEOS either have GEOSGeometry* as a parameter or a return type.
+* The generic type for a geometry. A geometry can be a Point, LineString, Polygon,
+* MultiPoint, MultiLineString, MultiPolygon, or GeometryCollection.
+* The geometry type can be read with \ref GEOSGeomTypeId. Most functions
+* in GEOS have `GEOSGeometry *` as either a parameter or a return type.
 * \see GEOSGeom_createPoint
 * \see GEOSGeom_createLineString
 * \see GEOSGeom_createPolygon
@@ -147,7 +147,8 @@ typedef struct GEOSGeom_t GEOSGeometry;
 typedef struct GEOSPrepGeom_t GEOSPreparedGeometry;
 
 /**
-* Coordinate sequence.
+* Coordinate sequence type representing fixed-size lists of coordinates.
+* Contains the list of vertices defining the location of a \ref GEOSGeometry.
 * \see GEOSCoordSeq_create()
 * \see GEOSCoordSeq_destroy()
 */

-----------------------------------------------------------------------

Summary of changes:
 capi/geos_c.h.in | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)


hooks/post-receive
-- 
GEOS