star-cad

commit 9091d955c1d2c520c31c48a3242b1cae3d10e01d
parent 0f2a42110df320b6ce7c51d346283c0ae9aa49a5
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Fri,  2 Sep 2022 18:10:20 +0200

More change in comments in scad.h

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

1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/src/scad.h b/src/scad.h
@@ -172,8 +172,8 @@ SCAD_API res_T
 scad_scene_mesh
   (void);
 
-/* Compute the boolean union (the fusion) of the geometries `geom1' and
- * `geom2'. */
+/* Compute the boolean union (the fusion) of the geometries in `geometries' and
+ * `tools'. */
 SCAD_API res_T
 scad_fuse_geometries
   (const char* name, /* Can be NULL */
@@ -183,7 +183,8 @@ scad_fuse_geometries
    const size_t tools_count,
    struct scad_geometry** out_geometry);
 
-/* Compute the boolean difference between the geometries `geom1' and `geom2'. */
+/* Compute the boolean difference between the geometries in `geometries' and
+ * `tools'. */
 SCAD_API res_T
 scad_cut_geometries
   (const char* name, /* Can be NULL */
@@ -194,7 +195,7 @@ scad_cut_geometries
    struct scad_geometry** out_geometry);
 
 /* Compute the boolean intersection (the common parts) of the geometries
- * `geom1' and `geom2'. */
+ * in `geometries' and `tools'. */
 SCAD_API res_T
 scad_intersect_geometries
   (const char* name, /* Can be NULL */
@@ -204,7 +205,8 @@ scad_intersect_geometries
    const size_t tools_count,
    struct scad_geometry** out_geometry);
 
-/* compute boundary intersection (the common part) of geom1 and geom2. */
+/* compute boundary intersection (the common part) of in `geometries' and
+ * `tools'. */
 SCAD_API res_T
 scad_geometries_common_boundaries 
   (const char* name, /* Can be NULL */
@@ -215,9 +217,9 @@ scad_geometries_common_boundaries
    struct scad_geometry** out_geometry);
 
 /* Compute the boolean fragments (general fuse) resulting from the
- * intersection of the geometries `geom1' and `geom2', making all interfaces
- * conformal. When applied to geometries of different dimensions, the lower
- * dimensional geometries will be automatically embedded in the higher
+ * intersection of the geometries in `geometries' and `tools', making all
+ * interfaces conformal. 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. */
 SCAD_API res_T
 scad_geometries_partition
@@ -234,14 +236,14 @@ SCAD_API res_T
 scad_geometry_boundary
   (const char* name, /* Can be NULL */
    struct scad_geometry* geom,
-   struct scad_geometry** out);
+   struct scad_geometry** out_boundary);
 
 /* copy the geometry `geom'. */
 SCAD_API res_T
 scad_geometry_copy
   (const struct scad_geometry* geom,
    const char* name, /* Can be NULL */
-   struct scad_geometry** copy);
+   struct scad_geometry** out_copy);
 
 /* Translate the geometry `geom' along (`dx', `dy', `dz'). */
 SCAD_API res_T