Synopsis tweaks and cleanups.

This commit is contained in:
Revar Desmera
2023-03-30 19:28:29 -07:00
parent 7f850271e7
commit a414922967
4 changed files with 41 additions and 7 deletions

View File

@@ -15,6 +15,7 @@
// Module: bounding_box()
// Synopsis: Creates the smallest bounding box that contains all the children.
// Topics: Mutators, Bounds, Bounding Boxes
// See Also: pointlist_bounds()
// Usage:
// bounding_box([excess],[planar]) CHILDREN;
// Description:
@@ -105,6 +106,7 @@ module bounding_box(excess=0, planar=false) {
// Module: chain_hull()
// Synopsis: Performs the union of hull operations between consecutive pairs of children.
// Topics: Mutators
// See Also: hull()
// Usage:
// chain_hull() CHILDREN;
//
@@ -270,6 +272,7 @@ module path_extrude2d(path, caps=false, closed=false, s, convexity=10) {
// Module: cylindrical_extrude()
// Synopsis: Extrudes 2D children outwards around a cylinder.
// Topics: Mutators, Extrusion, Rotation
// See Also: heightfield(), cylindrical_heightfield(), cyl()
// Usage:
// cylindrical_extrude(ir|id=, or|od=, [size=], [convexity=], [spin=], [orient=]) 2D-CHILDREN;
// Description:
@@ -331,6 +334,7 @@ module cylindrical_extrude(ir, or, od, id, size=1000, convexity=10, spin=0, orie
// Module: extrude_from_to()
// Extrudes 2D children between two points in 3D space.
// Topics: Extrusion, Mutators
// See Also: path_sweep(), path_extrude2d()
// Usage:
// extrude_from_to(pt1, pt2, [convexity=], [twist=], [scale=], [slices=]) 2D-CHILDREN;
// Description:
@@ -471,7 +475,7 @@ module minkowski_difference(planar=false) {
// Module: offset3d()
// Synopsis: Expands or contracts the surface of a 3D object.
// Topics: Mutators
// See Also: minkowski_difference()
// See Also: minkowski_difference(), round3d()
// Usage:
// offset3d(r, [size], [convexity]) CHILDREN;
// Description:
@@ -513,6 +517,7 @@ module offset3d(r, size=100, convexity=10) {
// Module: round3d()
// Synopsis: Rounds arbitrary 3d objects.
// Topics: Rounding, Mutators
// See Also: offset3d(), minkowski_difference()
// Usage:
// round3d(r) CHILDREN;
// round3d(or) CHILDREN;