star-cad

commit 48bfe7b4003b65fa52f5e4c78c02b6e9a0efee00
parent acf96be6021919142c1687d8bd22ff728c8cf415
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Fri,  9 Dec 2022 09:38:29 +0100

Some changes in API comments

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

1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/src/scad.h b/src/scad.h
@@ -132,8 +132,8 @@ scad_set_options
   (const struct scad_options* options); /* May be NULL: set default */
 
 /* Explicitly synchronize the current state with regard to recent geometry changes.
- * Most synchronize calls should be automatically triggered when needed.
- * TODO: remove when no more needed! */
+ * Synchronize calls should be automatically triggered when needed.
+ * Only provided as a way to check for auto-synchronize bugs! */
 SCAD_API res_T
 scad_synchronize
   (void);
@@ -163,7 +163,7 @@ scad_geometry_get_name
   (const struct scad_geometry* geom,
    char** name);
 
-/* Get the `mass' of the geometry `geom'. It means area for a 2D geometry and 
+/* Get the `mass' of the geometry `geom'. It means area for a 2D geometry and
  * volume for a 3D geometry. */
 SCAD_API res_T
 scad_geometry_get_mass
@@ -282,7 +282,7 @@ scad_geometries_common_boundaries
  * conformal.
  * If overlapping is allowed `out_geometries' is constructed and the new
  * geometries are created unnamed; if overlapping is not allowed
- * `out_geometries' is expected to be NULL.
+ * `out_geometries' remains unchanged and can be NULL.
  * When applied to geometries of different dimensions, the lower dimensional
  * geometries will be automatically embedded in the higher dimensional
  * geometries if they are not on their boundary. */
@@ -291,9 +291,10 @@ scad_geometries_partition
   (struct scad_geometry** geometries,
    const size_t geometries_count,
    const int allow_overlapping,
-   struct scad_geometry** out_geometries); /* NULL if overlapping not allowed */
+   struct scad_geometry** out_geometries); /* Can be NULL if overlapping disallowed */
 
-/* Same as above for the whole scene */
+/* Partition the whole scene.
+ * Overlapping is not detected and newly created objects are not returned. */
 SCAD_API res_T
 scad_scene_partition
   (void);