From 35132b603fbfd542059b78e9dbd257016723a081 Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Thu, 2 May 2019 11:00:22 +0800 Subject: [PATCH] see doc directly --- src/along_with.scad | 3 --- src/arc.scad | 4 ---- src/arc_path.scad | 4 ---- src/archimedean_spiral.scad | 12 ------------ src/archimedean_spiral_extrude.scad | 2 -- src/bend.scad | 2 -- src/bezier_curve.scad | 4 ---- src/bezier_smooth.scad | 2 -- src/bezier_surface.scad | 6 ------ src/box_extrude.scad | 2 -- src/circle_path.scad | 4 ---- src/cross_sections.scad | 3 --- src/crystal_ball.scad | 2 -- src/ellipse_extrude.scad | 3 --- src/function_grapher.scad | 7 ------- src/golden_spiral.scad | 4 ---- src/golden_spiral_extrude.scad | 2 -- src/helix.scad | 4 ---- src/helix_extrude.scad | 2 -- src/hexagons.scad | 3 --- src/hollow_out.scad | 2 -- src/hull_polyline2d.scad | 4 ---- src/hull_polyline3d.scad | 4 ---- src/line2d.scad | 2 -- src/line3d.scad | 2 -- src/log.scad | 2 -- src/multi_line_text.scad | 2 -- src/parse_number.scad | 4 ---- src/path_extrude.scad | 5 ----- src/paths2sections.scad | 2 -- src/pie.scad | 2 -- src/polyline2d.scad | 4 ---- src/polyline3d.scad | 3 --- src/polysections.scad | 3 --- src/polytransversals.scad | 3 --- src/ring_extrude.scad | 3 --- src/rotate_p.scad | 3 --- src/rounded_cube.scad | 3 --- src/rounded_cylinder.scad | 2 -- src/rounded_extrude.scad | 2 -- src/rounded_square.scad | 3 --- src/shape_arc.scad | 4 ---- src/shape_cyclicpolygon.scad | 4 ---- src/shape_ellipse.scad | 4 ---- src/shape_glued2circles.scad | 4 ---- src/shape_path_extend.scad | 5 ----- src/shape_pentagram.scad | 4 ---- src/shape_pie.scad | 4 ---- src/shape_square.scad | 4 ---- src/shape_starburst.scad | 4 ---- src/shape_superformula.scad | 4 ---- src/shape_taiwan.scad | 4 ---- src/shape_trapezium.scad | 4 ---- src/sphere_spiral.scad | 5 ----- src/sphere_spiral_extrude.scad | 2 -- src/split_str.scad | 3 --- src/stereographic_extrude.scad | 5 ----- src/sub_str.scad | 2 -- src/turtle2d.scad | 3 --- src/turtle3d.scad | 2 -- 60 files changed, 206 deletions(-) diff --git a/src/along_with.scad b/src/along_with.scad index 6108cbda..7f1748ce 100644 --- a/src/along_with.scad +++ b/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 * diff --git a/src/arc.scad b/src/arc.scad index d888ef66..9a87b854 100644 --- a/src/arc.scad +++ b/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 * diff --git a/src/arc_path.scad b/src/arc_path.scad index d82dd3c9..d94b8aa3 100644 --- a/src/arc_path.scad +++ b/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 * diff --git a/src/archimedean_spiral.scad b/src/archimedean_spiral.scad index e78b4b8f..cef6dc0b 100644 --- a/src/archimedean_spiral.scad +++ b/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, �c) Archimedean spiral can be described by the equation r = b�c where -* �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 diff --git a/src/archimedean_spiral_extrude.scad b/src/archimedean_spiral_extrude.scad index 6d259c42..82d2ffba 100644 --- a/src/archimedean_spiral_extrude.scad +++ b/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 * diff --git a/src/bend.scad b/src/bend.scad index 4b88ea9b..b19287a5 100644 --- a/src/bend.scad +++ b/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 diff --git a/src/bezier_curve.scad b/src/bezier_curve.scad index 1d52d962..6ed7b901 100644 --- a/src/bezier_curve.scad +++ b/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 * diff --git a/src/bezier_smooth.scad b/src/bezier_smooth.scad index 9e9b2b41..06ad1c3b 100644 --- a/src/bezier_smooth.scad +++ b/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 * diff --git a/src/bezier_surface.scad b/src/bezier_surface.scad index ac5b3a59..ccc36177 100644 --- a/src/bezier_surface.scad +++ b/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 * diff --git a/src/box_extrude.scad b/src/box_extrude.scad index 277d7060..689d6075 100644 --- a/src/box_extrude.scad +++ b/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 * diff --git a/src/circle_path.scad b/src/circle_path.scad index 62af17b4..b8e5f543 100644 --- a/src/circle_path.scad +++ b/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 * diff --git a/src/cross_sections.scad b/src/cross_sections.scad index 6fc4ca83..ae6979cf 100644 --- a/src/cross_sections.scad +++ b/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 * diff --git a/src/crystal_ball.scad b/src/crystal_ball.scad index 37e78be5..b684db53 100644 --- a/src/crystal_ball.scad +++ b/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 * diff --git a/src/ellipse_extrude.scad b/src/ellipse_extrude.scad index 98cf000a..8d81b297 100644 --- a/src/ellipse_extrude.scad +++ b/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 * diff --git a/src/function_grapher.scad b/src/function_grapher.scad index 332666ab..46c58870 100644 --- a/src/function_grapher.scad +++ b/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 * diff --git a/src/golden_spiral.scad b/src/golden_spiral.scad index 0bb87957..5277c3b8 100644 --- a/src/golden_spiral.scad +++ b/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 * diff --git a/src/golden_spiral_extrude.scad b/src/golden_spiral_extrude.scad index 4f33cc39..49084b9a 100644 --- a/src/golden_spiral_extrude.scad +++ b/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 * diff --git a/src/helix.scad b/src/helix.scad index f6679e19..142779b2 100644 --- a/src/helix.scad +++ b/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 * diff --git a/src/helix_extrude.scad b/src/helix_extrude.scad index e90685a2..47d3801c 100644 --- a/src/helix_extrude.scad +++ b/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 * diff --git a/src/hexagons.scad b/src/hexagons.scad index 97827635..c51c8888 100644 --- a/src/hexagons.scad +++ b/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 * diff --git a/src/hollow_out.scad b/src/hollow_out.scad index fa6814eb..c5e42dc3 100644 --- a/src/hollow_out.scad +++ b/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 * diff --git a/src/hull_polyline2d.scad b/src/hull_polyline2d.scad index 4f68808f..65a069e0 100644 --- a/src/hull_polyline2d.scad +++ b/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 * diff --git a/src/hull_polyline3d.scad b/src/hull_polyline3d.scad index cb1b5693..fcf5ea6d 100644 --- a/src/hull_polyline3d.scad +++ b/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 * diff --git a/src/line2d.scad b/src/line2d.scad index d1632480..f8035459 100644 --- a/src/line2d.scad +++ b/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 * diff --git a/src/line3d.scad b/src/line3d.scad index 14f99f84..dc295ca5 100644 --- a/src/line3d.scad +++ b/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 * diff --git a/src/log.scad b/src/log.scad index f6f2afd0..84a6067c 100644 --- a/src/log.scad +++ b/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 * diff --git a/src/multi_line_text.scad b/src/multi_line_text.scad index ab593efb..663c733a 100644 --- a/src/multi_line_text.scad +++ b/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 * diff --git a/src/parse_number.scad b/src/parse_number.scad index 6dbc26f7..921da61d 100644 --- a/src/parse_number.scad +++ b/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 * diff --git a/src/path_extrude.scad b/src/path_extrude.scad index 483ed805..bf260d2d 100644 --- a/src/path_extrude.scad +++ b/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 * diff --git a/src/paths2sections.scad b/src/paths2sections.scad index 4d866e22..c7eb55b2 100644 --- a/src/paths2sections.scad +++ b/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 * diff --git a/src/pie.scad b/src/pie.scad index a59b3c33..aff07e20 100644 --- a/src/pie.scad +++ b/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 * diff --git a/src/polyline2d.scad b/src/polyline2d.scad index 5bd6a0bb..8aca35c9 100644 --- a/src/polyline2d.scad +++ b/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 * diff --git a/src/polyline3d.scad b/src/polyline3d.scad index bf688376..897abd49 100644 --- a/src/polyline3d.scad +++ b/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 * diff --git a/src/polysections.scad b/src/polysections.scad index 3c0f439a..6625959f 100644 --- a/src/polysections.scad +++ b/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 * diff --git a/src/polytransversals.scad b/src/polytransversals.scad index f715aeb5..6022d2e8 100644 --- a/src/polytransversals.scad +++ b/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 * diff --git a/src/ring_extrude.scad b/src/ring_extrude.scad index c86c0721..3a3bb9d0 100644 --- a/src/ring_extrude.scad +++ b/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 * diff --git a/src/rotate_p.scad b/src/rotate_p.scad index 49b62f5c..7d23becb 100644 --- a/src/rotate_p.scad +++ b/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 * diff --git a/src/rounded_cube.scad b/src/rounded_cube.scad index e1bfc20f..18b3955a 100644 --- a/src/rounded_cube.scad +++ b/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 * diff --git a/src/rounded_cylinder.scad b/src/rounded_cylinder.scad index 7f95548f..e0def46a 100644 --- a/src/rounded_cylinder.scad +++ b/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 * diff --git a/src/rounded_extrude.scad b/src/rounded_extrude.scad index 3616be48..3e8468f6 100644 --- a/src/rounded_extrude.scad +++ b/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 * diff --git a/src/rounded_square.scad b/src/rounded_square.scad index 66f6d75b..38fd4c4d 100644 --- a/src/rounded_square.scad +++ b/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 * diff --git a/src/shape_arc.scad b/src/shape_arc.scad index ca8c1463..783b9c7a 100644 --- a/src/shape_arc.scad +++ b/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 * diff --git a/src/shape_cyclicpolygon.scad b/src/shape_cyclicpolygon.scad index defa0678..d4a3be54 100644 --- a/src/shape_cyclicpolygon.scad +++ b/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 * diff --git a/src/shape_ellipse.scad b/src/shape_ellipse.scad index 498f2d70..e7ed4548 100644 --- a/src/shape_ellipse.scad +++ b/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 * diff --git a/src/shape_glued2circles.scad b/src/shape_glued2circles.scad index 5f6ae9c6..73318d19 100644 --- a/src/shape_glued2circles.scad +++ b/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 * diff --git a/src/shape_path_extend.scad b/src/shape_path_extend.scad index 161f94ab..913e716a 100644 --- a/src/shape_path_extend.scad +++ b/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 * diff --git a/src/shape_pentagram.scad b/src/shape_pentagram.scad index 682c776e..0f8966f8 100644 --- a/src/shape_pentagram.scad +++ b/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 * diff --git a/src/shape_pie.scad b/src/shape_pie.scad index 44f69992..89885e1e 100644 --- a/src/shape_pie.scad +++ b/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 * diff --git a/src/shape_square.scad b/src/shape_square.scad index 9f2c1cb5..b43685a4 100644 --- a/src/shape_square.scad +++ b/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 * diff --git a/src/shape_starburst.scad b/src/shape_starburst.scad index 248a213e..6cc15710 100644 --- a/src/shape_starburst.scad +++ b/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 * diff --git a/src/shape_superformula.scad b/src/shape_superformula.scad index f8afb5fa..169d0129 100644 --- a/src/shape_superformula.scad +++ b/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 * diff --git a/src/shape_taiwan.scad b/src/shape_taiwan.scad index ae925eb3..1c94f1a2 100644 --- a/src/shape_taiwan.scad +++ b/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 * diff --git a/src/shape_trapezium.scad b/src/shape_trapezium.scad index 39a3e42c..183202a9 100644 --- a/src/shape_trapezium.scad +++ b/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 * diff --git a/src/sphere_spiral.scad b/src/sphere_spiral.scad index 375ba450..25858319 100644 --- a/src/sphere_spiral.scad +++ b/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 * diff --git a/src/sphere_spiral_extrude.scad b/src/sphere_spiral_extrude.scad index 81b9f092..26329bd2 100644 --- a/src/sphere_spiral_extrude.scad +++ b/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 * diff --git a/src/split_str.scad b/src/split_str.scad index bd43e0bf..c8f311da 100644 --- a/src/split_str.scad +++ b/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 * diff --git a/src/stereographic_extrude.scad b/src/stereographic_extrude.scad index efd57169..34da4499 100644 --- a/src/stereographic_extrude.scad +++ b/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 * diff --git a/src/sub_str.scad b/src/sub_str.scad index 5746b53f..3df9ca87 100644 --- a/src/sub_str.scad +++ b/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 * diff --git a/src/turtle2d.scad b/src/turtle2d.scad index 0ac58609..5ab77606 100644 --- a/src/turtle2d.scad +++ b/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 * diff --git a/src/turtle3d.scad b/src/turtle3d.scad index b67ba54a..c93448ed 100644 --- a/src/turtle3d.scad +++ b/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 *