star-3dut

commit 505faaa83c2f5c96b3a1e6b4db0face888857907
parent 06d3b6f5ae95ca50a3af874b31ea5226846740bc
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Fri,  6 Oct 2017 17:12:23 +0200

Improve comments.

Diffstat:
M
src/s3dut.h
 | 
12
+++++-------

1 file changed, 5 insertions(+), 7 deletions(-)
diff --git a/src/s3dut.h b/src/s3dut.h
@@ -80,8 +80,8 @@ s3dut_create_sphere
 
 /* Create a triangulated cylinder centered in 0 discretized in `nslices' around
  * the Z axis and `nstacks' along the Z axis. The top and the bottom ends of
- * the cylinder can be closed with a triangle fan whose center is on the Z axis
- * or not, according to the `close_ends' argument bit mask. Facevertices are
+ * the cylinder can be closed  or not with a triangle fan whose center is on the
+ * Z axis, according to the `close_ends' argument bit mask. Face vertices are
  * CCW ordered with respect to the cylinder center, i.e. they are CW ordered
  * from the outside point of view. */
 S3DUT_API res_T
@@ -104,9 +104,9 @@ s3dut_create_cylinder
 S3DUT_API res_T
 s3dut_create_thick_cylinder
   (struct mem_allocator* allocator, /* May be NULL <=> use default allocator */
-   const double radius, /* In ]thickness, INF) */
-   const double height, /* In ]min_height, INF);
-     min_height = 0, tickness or 2*thickness according to close_ends */
+   const double radius, /* In ]thickness, INF); exterior radius */
+   const double height, /* In ]min_height, INF); min_height = 0,
+                           tickness or 2*thickness according to close_ends */
    const double thickness, /* In ]0, INF) */
    const unsigned nslices, /* # subdivisions around Z axis in [3, INF) */
    const unsigned nstacks, /* # subdivision along Z axis in [1, INF) */
@@ -137,6 +137,4 @@ s3dut_create_hemisphere
    const unsigned nstacks, /* # subdivisions along Z axis int [2, INF) */
    struct s3dut_mesh** hemisphere);
 
-
 #endif /* S3DUT_H */
-