[geos-commits] [SCM] GEOS branch main updated. 665890e6e384103dede1553ae8ab468271b0515f

[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  665890e6e384103dede1553ae8ab468271b0515f (commit)
      from  b53afe675cb21b7f2689eae72f6dd3b10bb87d78 (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 665890e6e384103dede1553ae8ab468271b0515f
Author: Martin Davis <mtnclimb at gmail.com>
Date:   Mon Apr 17 13:48:37 2023 -0700

    Improve C API doc

diff --git a/capi/geos_c.h.in b/capi/geos_c.h.in
index faac0e8a1..0b3589eb5 100644
--- a/capi/geos_c.h.in
+++ b/capi/geos_c.h.in
@@ -16,24 +16,25 @@
 * \brief C API for the GEOS geometry algorithms library.
 * \tableofcontents
 *
-* The C API is the preferred API to use when integrating GEOS into
-* your application/library/etc. While the C++ API is available, the ABI
-* will not be stable between versions, and the API may also change.
+* The C API is the supported API to use 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.
 *
 * Important programming notes:
 *
-* - Remember to call initGEOS() before any use of this library's
-*   functions, and call finishGEOS() when done.
-* - Currently you have to explicitly GEOSGeom_destroy() all
-*   GEOSGeom objects to avoid memory leaks, and GEOSFree()
+* - Call initGEOS() before using the library functions.
+* - 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).
-* - Functions ending with _r are thread safe (reentrant);
+* - 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,
-*   define GEOS_USE_ONLY_R_API before including geos_c.h.
+*   define `GEOS_USE_ONLY_R_API` before including geos_c.h.
 *
 */
 

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

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


hooks/post-receive
-- 
GEOS