see doc directly

src/along_with.scad

@@ -1,9 +1,6 @@
 /**
 * along_with.scad
 *
-* Puts children along the given path. If there's only one child, 
-* it will put the child for each point. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/arc.scad

@@ -1,10 +1,6 @@
 /**
 * arc.scad
 *
-* 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.
-* It depends on the circular_sector module so you have to include circular_sector.scad.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/arc_path.scad

@@ -1,10 +1,6 @@
 /**
 * arc_shape.scad
 *
-* 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.
-* It depends on the circular_sector module so you have to include circular_sector.scad.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/archimedean_spiral.scad

@@ -1,17 +1,5 @@
 /**
 * archimedean_spiral.scad
-*
-*  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]. 
-*
-*  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.
-*
-*  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 
-*  is required. To avoid a small error value at the calculated distance between two points, you 
-*  may try a smaller point_distance.
 * 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html

src/archimedean_spiral_extrude.scad

@@ -1,8 +1,6 @@
 /**
 * archimedean_spiral_extrude.scad
 *
-* Extrudes a 2D shape along the path of a archimedean spiral.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/bend.scad

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

src/bezier_curve.scad

@@ -1,10 +1,6 @@
 /**
 * bezier_curve.scad
 *
-* Given a set of control points, the bezier_curve function returns points of the Bézier path. 
-* Combined with the polyline, polyline3d or hull_polyline3d module defined in my lib-openscad, 
-* you can create a Bézier curve.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/bezier_smooth.scad

@@ -1,8 +1,6 @@
 /**
 * bezier_smooth.scad
 *
-* Given a path, the bezier_smooth function uses bazier curves to smooth all corners. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/bezier_surface.scad

@@ -1,12 +1,6 @@
 /**
 * bezier_surface.scad
 *
-* Given a set of control points, the bezier_surface function returns points of the Bézier surface. 
-* Combined with the function_grapher module defined in my lib-openscad, 
-* you can create a Bézier surface.
-*
-* It depends on the bezier_curve function so remember to include bezier_curve.scad.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/box_extrude.scad

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

src/circle_path.scad

@@ -1,10 +1,6 @@
 /**
 * circle_path.scad
 *
-* Sometimes you need all points on the path of a circle. Here's 
-* the function. Its $fa, $fs and $fn parameters are consistent 
-* with the circle module.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/cross_sections.scad

@@ -1,9 +1,6 @@
 /**
 * cross_sections.scad
 *
-* Given a 2D shape, points and angles along the path, this function
-* will return all cross-sections.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/crystal_ball.scad

@@ -1,8 +1,6 @@
 /**
 * crystal_ball.scad
 *
-* Uses Spherical coordinate system to create a crystal ball. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/ellipse_extrude.scad

@@ -1,9 +1,6 @@
 /**
 * ellipse_extrude.scad
 *
-* Extrudes a 2D object along the path of an ellipse from 0 to 180 degrees.
-* The semi-major axis is not necessary because it's eliminated while calculating.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/function_grapher.scad

@@ -1,13 +1,6 @@
 /**
 * function_grapher.scad
 *
-* 
-* Given a set of points `[x, y, f(x, y)]` where `f(x, y)` is a 
-* mathematics function, the `function_grapher` module can 
-* create the graph of `f(x, y)`.
-* It depends on the line3d, polyline3d, hull_polyline3d modules so you have 
-* to include "line3d.scad", "polyline3d.scad", "hull_polyline3d.scad".
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/golden_spiral.scad

@@ -1,10 +1,6 @@
 /**
 * golden_spiral.scad
 *
-*  Gets all points and angles on the path of a golden spiral. The distance between two  points is almost constant. 
-* 
-*  It returns a vector of [[x, y], angle]. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/golden_spiral_extrude.scad

@@ -1,8 +1,6 @@
 /**
 * golden_spiral_extrude.scad
 *
-* Extrudes a 2D shape along the path of a golden spiral.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/helix.scad

@@ -1,10 +1,6 @@
 /**
 * helix.scad
 *
-* Gets all points on the path of a spiral around a cylinder. 
-* 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.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/helix_extrude.scad

@@ -1,8 +1,6 @@
 /**
 * helix_extrude.scad
 *
-* Extrudes a 2D shape along a helix path.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/hexagons.scad

@@ -1,9 +1,6 @@
 /**
 * hexagons.scad
 *
-* A hexagonal structure is useful in many situations. 
-* This module creates hexagons in a hexagon.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/hollow_out.scad

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

src/hull_polyline2d.scad

@@ -1,10 +1,6 @@
 /**
 * hull_polyline2d.scad
 *
-* Creates a 2D polyline from a list of `[x, y]` coordinates. 
-* As the name says, it uses the built-in hull operation for each pair of points (created by the circle module). 
-* It's slow. However, it can be used to create metallic effects for a small $fn, large $fa or $fs.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/hull_polyline3d.scad

@@ -1,10 +1,6 @@
 /**
 * hull_polyline3d.scad
 *
-* Creates a 3D polyline from a list of `[x, y, z]` coordinates. 
-* As the name says, it uses the built-in hull operation for each pair of points (created by the sphere module). 
-* It's slow. However, it can be used to create metallic effects for a small $fn, large $fa or $fs.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/line2d.scad

@@ -1,8 +1,6 @@
 /**
 * line2d.scad
 *
-* Creates a line from two points.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/line3d.scad

@@ -1,8 +1,6 @@
 /**
 * line3d.scad
 *
-* Creates a 3D line from two points. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/log.scad

@@ -1,8 +1,6 @@
 /**
 * log.scad
 *
-* A log module which supports simple level configurations and color titles.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/multi_line_text.scad

@@ -1,8 +1,6 @@
 /**
 * multi_line_text.scad
 *
-* Creates multi-line text from a list of strings. 
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/parse_number.scad

@@ -1,10 +1,6 @@
 /**
 * parse_number.scad
 *
-* Parses the string argument as an number.
-* It depends on the split_str and the sub_str functions 
-* so remember to include split_str.scad and sub_str.scad.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/path_extrude.scad

@@ -1,11 +1,6 @@
 /**
 * path_extrude.scad
 *
-* It extrudes a 2D shape along a path. 
-* This module is suitable for a path created by a continuous function.
-* It depends on the rotate_p function and the polysections module. 
-* Remember to include "rotate_p.scad" and "polysections.scad".
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/paths2sections.scad

@@ -1,8 +1,6 @@
 /**
 * paths2sections.scad
 *
-* Given a list of paths, this function will return all cross-sections described by those paths.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/pie.scad

@@ -1,8 +1,6 @@
 /**
 * pie.scad
 *
-* Creates a pie (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
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/polyline2d.scad

@@ -1,10 +1,6 @@
 /**
 * polyline2d.scad
 *
-* Creates a polyline from a list of x, y coordinates. When the end points are CAP_ROUND, 
-* you can use $fa, $fs or $fn to controll the circle module used internally. 
-* It depends on the line2d module so you have to include line2d.scad.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/polyline3d.scad

@@ -1,9 +1,6 @@
 /**
 * polyline3d.scad
 *
-* Creates a 3D polyline from a list of `[x, y, z]` coordinates. 
-* It depends on the line3d module so you have to include line3d.scad.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/polysections.scad

@@ -1,9 +1,6 @@
 /**
 * polysections.scad
 *
-* Crosscutting a tube-like shape at different points gets several cross-sections.
-* This module can operate reversely. It uses cross-sections to construct a tube-like shape.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/polytransversals.scad

@@ -1,9 +1,6 @@
 /**
 * polytransversals.scad
 *
-* Crosscutting a polyline at different points gets several transversals.
-* This module can operate reversely. It uses transversals to construct a polyline.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/ring_extrude.scad

@@ -1,9 +1,6 @@
 /**
 * ring_extrude.scad
 *
-* Rotational extrusion spins a 2D shape around the Z-axis.  
-* It's similar to the built-in `rotate_extrude`; however, it supports angle, twist and scale options.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/rotate_p.scad

@@ -1,9 +1,6 @@
 /**
 * rotate_p.scad
 *
-* Rotates a point 'a' degrees around an arbitrary axis. 
-* The rotation is applied in the following order: x, y, z. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/rounded_cube.scad

@@ -1,9 +1,6 @@
 /**
 * rounded_cube.scad
 *
-* Creates a rounded cube in the first octant. 
-* When center is true, the cube is centered on the origin.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/rounded_cylinder.scad

@@ -1,8 +1,6 @@
 /**
 * rounded_cylinder.scad
 *
-* Creates a rounded cylinder. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/rounded_extrude.scad

@@ -1,8 +1,6 @@
 /**
 * rounded_extrude.scad
 *
-* Extrudes a 2D object roundly from 0 to 180 degrees.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/rounded_square.scad

@@ -1,9 +1,6 @@
 /**
 * rounded_square.scad
 *
-* Creates a rounded square or rectangle in the first quadrant. 
-* When center is true the square is centered on the origin.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_arc.scad

@@ -1,10 +1,6 @@
 /**
 * shape_arc.scad
 *
-* Returns shape points of an arc shape. 
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_cyclicpolygon.scad

@@ -1,10 +1,6 @@
 /**
 * shape_cyclicpolygon.scad
 *
-* Returns shape points of a regular cyclic polygon.
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_ellipse.scad

@@ -1,10 +1,6 @@
 /**
 * shape_ellipse.scad
 *
-* Returns shape points of an ellipse.
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_glued2circles.scad

@@ -2,10 +2,6 @@
 /**
 * shape_glued2circles.scad
 *
-* Returns shape points of two glued circles. 
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_path_extend.scad

@@ -1,11 +1,6 @@
 /**
 * shape_path_extend.scad
 *
-* It extends a 2D stroke along a path. 
-* This module is suitable for a path created by a continuous function.
-* It depends on the rotate_p function and the polytransversals module. 
-* Remember to include "rotate_p.scad" and "polytransversals.scad".
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_pentagram.scad

@@ -1,10 +1,6 @@
 /**
 * shape_pentagram.scad
 *
-* Returns shape points of a pentagram.
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_pie.scad

@@ -1,10 +1,6 @@
 /**
 * shape_pie.scad
 *
-* Returns shape points of a pie (circular sector) shape.
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_square.scad

@@ -1,10 +1,6 @@
 /**
 * shape_square.scad
 *
-* Returns shape points of a rounded square or rectangle.
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_starburst.scad

@@ -1,10 +1,6 @@
 /**
 * shape_star.scad
 *
-* Returns shape points of a starburst.
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_superformula.scad

@@ -1,10 +1,6 @@
 /**
 * shape_superformula.scad
 *
-* Returns shape points of a Superformula shape. 
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_taiwan.scad

@@ -1,10 +1,6 @@
 /**
 * shape_taiwan.scad
 *
-* Returns shape points of Taiwan.
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/shape_trapezium.scad

@@ -1,10 +1,6 @@
 /**
 * shape_trapezium.scad
 *
-* Returns shape points of an isosceles trapezium.
-* They can be used with xxx_extrude modules of dotSCAD.
-* The shape points can be also used with the built-in polygon module. 
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/sphere_spiral.scad

@@ -1,11 +1,6 @@
 /**
 * sphere_spiral.scad
 *
-* Creates all points and angles on the path of a spiral around a sphere. 
-* It returns a vector of [[x, y, z], [ax, ay, az]]. [x, y, z] is actually
-* obtained from rotating [radius, 0, 0] by [ax, ay, az].
-* It depends on the rotate_p function. Remember to include rotate_p.scad first.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/sphere_spiral_extrude.scad

@@ -1,8 +1,6 @@
 /**
 * sphere_spiral_extrude.scad
 *
-* Extrudes a 2D shape along the path of a sphere spiral.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/split_str.scad

@@ -1,9 +1,6 @@
 /**
 * split_str.scad
 *
-* Splits the given string around matches of the given delimiting character.
-* It depends on the sub_str function so remember to include sub_str.scad.
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/stereographic_extrude.scad

@@ -1,11 +1,6 @@
 /**
 * stereographic_extrude.scad
 *
-* Takes a 2D polygon as input and extends it onto a sphere. 
-* If you light up a lamp on the north pole of the sphere, the 
-* shadow will return to the original 2D polygon. For more 
-* information, take a look at [Stereographic projection](https://en.wikipedia.org/wiki/Stereographic_projection).
-*
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/sub_str.scad

@@ -1,8 +1,6 @@
 /**
 * sub_str.scad
 *
-* Returns a new string that is a substring of the given string.
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/turtle2d.scad

@@ -1,9 +1,6 @@
 /**
 * turtle2d.scad
 *
-* An OpenSCAD implementation of Turtle Graphics. 
-* It moves on the xy plane. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *

src/turtle3d.scad

@@ -1,8 +1,6 @@
 /**
 * turtle3d.scad
 *
-* An OpenSCAD implementation of 3D Turtle Graphics. 
-* 
 * @copyright Justin Lin, 2017
 * @license https://opensource.org/licenses/lgpl-3.0.html
 *