[geos-commits] [SCM] GEOS branch main updated. 261ec0fd7eba41d675bbf37b597d4f1e5fba4104

[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  261ec0fd7eba41d675bbf37b597d4f1e5fba4104 (commit)
      from  665890e6e384103dede1553ae8ab468271b0515f (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 261ec0fd7eba41d675bbf37b597d4f1e5fba4104
Author: Martin Davis <mtnclimb at gmail.com>
Date:   Mon Apr 17 14:40:24 2023 -0700

    Improve GEOS C API header doc

diff --git a/capi/geos_c.h.in b/capi/geos_c.h.in
index 0b3589eb5..7e0d75fc3 100644
--- a/capi/geos_c.h.in
+++ b/capi/geos_c.h.in
@@ -16,13 +16,12 @@
 * \brief C API for the GEOS geometry algorithms library.
 * \tableofcontents
 *
-* The C API is the supported API to use GEOS in
+* The C API is the supported API for using GEOS in
 * your application/library/etc.
-* The GEOS team makes an effort to keep the C API stable, and to
-* deprecate function signatures only over a long time period to allow
-* transition time.
-* While the C++ API is available, the ABI
-* will not be stable between versions, and the API may change.
+* The C API is kept stable, and deprecated function signatures
+* are kept available over a long time period to allow transition time.
+* While the C++ API is available, it may change at any time, and the ABI
+* may not be stable between versions.
 *
 * Important programming notes:
 *
@@ -30,7 +29,7 @@
 * - Call finishGEOS() when finished using the library.
 * - To avoid memory leaks, call GEOSGeom_destroy() on
 *   \ref GEOSGeometry objects, and call GEOSFree() on
-*   all returned char * (unless const).
+*   returned `char *` strings and byte buffers (unless marked `const`).
 * - Functions ending with `_r` are thread safe (reentrant);
 *   see details in https://libgeos.org/development/rfcs/rfc03.
 *   To avoid accidental use of non-reentrant functions,

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

Summary of changes:
 capi/geos_c.h.in | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)


hooks/post-receive
-- 
GEOS