1
0
mirror of https://github.com/JustinSDK/dotSCAD.git synced 2025-08-23 14:54:12 +02:00

updated comments

This commit is contained in:
Justin Lin
2017-04-11 15:41:46 +08:00
parent bede5927ad
commit 35e98897f3
7 changed files with 11 additions and 11 deletions

View File

@@ -1,7 +1,7 @@
/** /**
* arc.scad * arc.scad
* *
* Create an arc. You can pass a 2 element vector to define the central angle. * Creates an arc. You can pass a 2 element vector to define the central angle.
* Its $fa, $fs and $fn parameters are consistent with the circle module. * Its $fa, $fs and $fn parameters are consistent with the circle module.
* It depends on the circular_sector module so you have to include circular_sector.scad. * It depends on the circular_sector module so you have to include circular_sector.scad.
* *

View File

@@ -1,12 +1,12 @@
/** /**
* archimedean_spiral.scad * archimedean_spiral.scad
* *
* Get all points and angles on the path of an archimedean_spiral. The distance between two points is almost constant. * Gets all points and angles on the path of an archimedean_spiral. The distance between two points is almost constant.
* *
* It returns a vector of [[x, y], angle]. * It returns a vector of [[x, y], angle].
* *
* In polar coordinates (r, <20>c) Archimedean spiral can be described by the equation r = b<>c where * In polar coordinates (r, <20>c) Archimedean spiral can be described by the equation r = b<>c where
* <20>c is measured in radians. For being consistent with OpenSCAD, the function here use degrees. * <20>c is measured in radians. For being consistent with OpenSCAD, the function here use degrees.
* *
* An init_angle less than 180 degrees is not recommended because the function uses an approximate * An init_angle less than 180 degrees is not recommended because the function uses an approximate
* approach. If you really want an init_angle less than 180 degrees, a larger arm_distance * approach. If you really want an init_angle less than 180 degrees, a larger arm_distance
@@ -39,8 +39,8 @@ function _find_radians(b, point_distance, radians, n, count = 1) =
); );
/* /*
In polar coordinates (r, <20>c) Archimedean spiral can be described by the equation r = b<>c where In polar coordinates (r, <20>c) Archimedean spiral can be described by the equation r = b<>c where
<20>c is measured in radians. For being consistent with OpenSCAD, the function here use degrees. <20>c is measured in radians. For being consistent with OpenSCAD, the function here use degrees.
An init_angle angle less than 180 degrees is not recommended because the function uses an An init_angle angle less than 180 degrees is not recommended because the function uses an
approximate approach. If you really want an angle less than 180 degrees, a larger arm_distance approximate approach. If you really want an angle less than 180 degrees, a larger arm_distance
is required. To avoid a small error value at the calculated distance between two points, you is required. To avoid a small error value at the calculated distance between two points, you

View File

@@ -1,7 +1,7 @@
/** /**
* bend.scad * bend.scad
* *
* Bend a 3D object into an arc shape. * Bends a 3D object into an arc shape.
* *
* @copyright Justin Lin, 2017 * @copyright Justin Lin, 2017
* @license https://opensource.org/licenses/lgpl-3.0.html * @license https://opensource.org/licenses/lgpl-3.0.html

View File

@@ -1,7 +1,7 @@
/** /**
* box_extrude.scad * box_extrude.scad
* *
* Create a box (container) from a 2D object. * Creates a box (container) from a 2D object.
* *
* @copyright Justin Lin, 2017 * @copyright Justin Lin, 2017
* @license https://opensource.org/licenses/lgpl-3.0.html * @license https://opensource.org/licenses/lgpl-3.0.html

View File

@@ -1,7 +1,7 @@
/** /**
* circular_sector.scad * circular_sector.scad
* *
* Create a circular sector. You can pass a 2 element vector to define the central angle. Its $fa, $fs and $fn parameters are consistent with the circle module. * Creates a circular sector. You can pass a 2 element vector to define the central angle. Its $fa, $fs and $fn parameters are consistent with the circle module.
* *
* @copyright Justin Lin, 2017 * @copyright Justin Lin, 2017
* @license https://opensource.org/licenses/lgpl-3.0.html * @license https://opensource.org/licenses/lgpl-3.0.html

View File

@@ -1,7 +1,7 @@
/** /**
* helix.scad * helix.scad
* *
* Get all points on the path of a spiral around a cylinder. * Gets all points on the path of a spiral around a cylinder.
* Its $fa, $fs and $fn parameters are consistent with the cylinder module. * Its $fa, $fs and $fn parameters are consistent with the cylinder module.
* It depends on the circle_path module so you have to include circle_path.scad. * It depends on the circle_path module so you have to include circle_path.scad.
* *

View File

@@ -1,7 +1,7 @@
/** /**
* hollow_out.scad * hollow_out.scad
* *
* Hollow out a 2D object. * Hollows out a 2D object.
* *
* @copyright Justin Lin, 2017 * @copyright Justin Lin, 2017
* @license https://opensource.org/licenses/lgpl-3.0.html * @license https://opensource.org/licenses/lgpl-3.0.html