star-cad

commit 0e1d6441062aae2ce886e4875a834e6271462d54
parent 146d4b8c052d7eac5cee896abd715be391cde45a
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Wed, 11 Jan 2023 10:49:36 +0100

Fix API comments

Diffstat:
M
src/scad.h
 | 
8
++++----

1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/scad.h b/src/scad.h
@@ -159,7 +159,7 @@ SCAD_API res_T
 scad_scene_clear
   (void);
 
-/* Get the number of connex components of the geometry `geom' */
+/* Get the number of components of the geometry `geom' */
 SCAD_API res_T
 scad_geometry_get_count
   (const struct scad_geometry* geom,
@@ -187,12 +187,12 @@ scad_geometry_get_mass
    double* mass);
 
 /* Get the center of mass of the various components of the geometry.
- * Note that `center' is allocated using the allocator provided when
- * initializing star-cad and should be freed accordingly. */
+ * Note that `center' must be allocated be the caller with enough room for (at
+ * least) 3 times the count of geom (scad_geometry_ge_count) doubles */
 SCAD_API res_T
 scad_geometry_get_centerofmass
   (struct scad_geometry* geom,
-   double* center); /* should have room for 3*scad_geometry_get_count(geom) doubles */
+   double* center);
 
 /* Add a rectangle to the scene, defined by a point `xyz' and
  * `dxdy' the extents along the x-, y-axes. */