diff --git a/bottlecaps.scad b/bottlecaps.scad index 57bf810..194cfa8 100644 --- a/bottlecaps.scad +++ b/bottlecaps.scad @@ -1,6 +1,6 @@ ////////////////////////////////////////////////////////////////////// // LibFile: bottlecaps.scad -// Bottle caps and necks for PCO18XX standard plastic beverage bottles. +// Bottle caps and necks for PCO18XX standard plastic beverage bottles, and SPI standard bottle necks. // Includes: // include // include diff --git a/color.scad b/color.scad index 72e0b14..b7a8ffd 100644 --- a/color.scad +++ b/color.scad @@ -1,10 +1,12 @@ ////////////////////////////////////////////////////////////////////// // LibFile: color.scad -// HSV and HSL conversion, and raindow module for coloring multiple objects. +// HSV and HSL conversion, raindow() module for coloring multiple objects. +// The recolor() and color_this() modules allow you to change the color +// of previously colored attachable objects. // Includes: // include // FileGroup: Basic Modeling -// FileSummary: HSV and HSL conversion, color multiple objects +// FileSummary: HSV and HSL conversion, color multiple objects, change color of objects // FileFootnotes: STD=Included in std.scad ////////////////////////////////////////////////////////////////////// diff --git a/constants.scad b/constants.scad index 23f8acb..1590a29 100644 --- a/constants.scad +++ b/constants.scad @@ -1,8 +1,11 @@ ////////////////////////////////////////////////////////////////////// // LibFile: constants.scad -// Useful Constants. +// Constants for directions (used with anchoring), and for specifying line termination for +// use with geometry.scad. // Includes: // include +// FileSummary: Constants provided by the library + ////////////////////////////////////////////////////////////////////// // a value that the user should never enter randomly; diff --git a/distributors.scad b/distributors.scad index 2f62f63..e20c5b7 100644 --- a/distributors.scad +++ b/distributors.scad @@ -1,10 +1,12 @@ ////////////////////////////////////////////////////////////////////// // LibFile: distributors.scad -// Functions and modules to distribute children or copies of children. +// Functions and modules to distribute children or copies of children onto +// a line, a grid, or an arbitrary path. The $idx mechanism means that +// the "copies" of children can vary. Also includes shortcuts for mirroring. // Includes: // include // FileGroup: Basic Modeling -// FileSummary: Copy or distribute objects onto a line or grid. Mirror shortcuts. +// FileSummary: Copy or distribute objects onto a line, grid, or path. Mirror shortcuts. // FileFootnotes: STD=Included in std.scad ////////////////////////////////////////////////////////////////////// diff --git a/drawing.scad b/drawing.scad index 953ef0e..a9a4204 100644 --- a/drawing.scad +++ b/drawing.scad @@ -5,7 +5,7 @@ // three-dimensional paths. You can make a dashed line or add arrow // heads. The turtle() function provides a turtle graphics style // approach for producing paths. The arc() function produces arc paths, -// and helix() produces helix paths. +// and helix() produces helical paths. // Includes: // include // FileGroup: Basic Modeling diff --git a/gears.scad b/gears.scad index bc616bf..c7bff6b 100644 --- a/gears.scad +++ b/gears.scad @@ -1,8 +1,7 @@ ////////////////////////////////////////////////////////////////////////////////////////////// // LibFile: gears.scad // Spur Gears, Bevel Gears, Racks, Worms and Worm Gears. -// Originally based on code by Leemon Baird, 2011, Leemon@Leemon.com -// Almost completely rewritten for BOSL2 by Revar Desmera, 2017-2021, revarbat@gmail.com +// Inspired by code by Leemon Baird, 2011, Leemon@Leemon.com // Includes: // include // include diff --git a/hingesnaps.scad b/hingesnaps.scad index ad91a38..b437b6d 100644 --- a/hingesnaps.scad +++ b/hingesnaps.scad @@ -1,6 +1,7 @@ ////////////////////////////////////////////////////////////////////// // LibFile: hingesnaps.scad -// Useful hinge mask and snaps shapes. +// Modules for creating snap-locking foldable hined parts. Includes the mask to create the hinge and +// modules to create the snap-locks. // Includes: // include // include diff --git a/linear_bearings.scad b/linear_bearings.scad index 88a1426..93dc2e9 100644 --- a/linear_bearings.scad +++ b/linear_bearings.scad @@ -1,6 +1,6 @@ ////////////////////////////////////////////////////////////////////// // LibFile: linear_bearings.scad -// Linear Bearing clips/holders. +// Mounts for LMxUU style linear bearings. // Includes: // include // include diff --git a/masks3d.scad b/masks3d.scad index 790b1be..dcecfc9 100644 --- a/masks3d.scad +++ b/masks3d.scad @@ -5,7 +5,7 @@ // Includes: // include // FileGroup: Basic Modeling -// FileSummary: 3D masks for rounding edges and corners. +// FileSummary: 3D masks for rounding or chamfering edges and corners. // FileFootnotes: STD=Included in std.scad ////////////////////////////////////////////////////////////////////// diff --git a/modular_hose.scad b/modular_hose.scad index 21f1093..d9980c0 100644 --- a/modular_hose.scad +++ b/modular_hose.scad @@ -5,7 +5,7 @@ // include // include // FileGroup: Parts -// FileSummary: Modular flexible hose parts. +// FileSummary: Modular flexible hose segments. ////////////////////////////////////////////////////////////////////////// // Section: Modular Hose Parts diff --git a/nema_steppers.scad b/nema_steppers.scad index e1341ef..058b8bb 100644 --- a/nema_steppers.scad +++ b/nema_steppers.scad @@ -1,6 +1,6 @@ ////////////////////////////////////////////////////////////////////// // LibFile: nema_steppers.scad -// Masks and models for NEMA stepper motors. +// Mounting holes for NEMA motors, and simple motor models. // Includes: // include // include diff --git a/paths.scad b/paths.scad index d19d3ca..bbce0ca 100644 --- a/paths.scad +++ b/paths.scad @@ -2,7 +2,8 @@ // LibFile: paths.scad // A `path` is a list of points of the same dimensions, usually 2D or 3D, that can // be connected together to form a sequence of line segments or a polygon. -// The functions in this file work on paths and also 1-regions, which are regions +// A `region` is a list of paths that represent polygons, and the functions +// in this file work on paths and also 1-regions, which are regions // that include exactly one path. When you pass a 1-region to a function, the default // value for `closed` is always `true` because regions represent polygons. // Capabilities include computing length of paths, computing diff --git a/regions.scad b/regions.scad index 827c385..d789499 100644 --- a/regions.scad +++ b/regions.scad @@ -3,7 +3,7 @@ // This file provides 2D boolean set operations on polygons, where you can // compute, for example, the intersection or union of the shape defined by point lists, producing // a new point list. Of course, such operations may produce shapes with multiple -// components. To handle that, we use "regions" which are defined by lists of polygons. +// components. To handle that, we use "regions" which are lists of paths representing the polygons. // In addition to set operations, you can calculate offsets, determine whether a point is in a // region and you can decompose a region into parts. // Includes: diff --git a/rounding.scad b/rounding.scad index de51e87..766a37c 100644 --- a/rounding.scad +++ b/rounding.scad @@ -2,11 +2,14 @@ // LibFile: rounding.scad // Routines to create rounded corners, with either circular rounding, // or continuous curvature rounding with no sudden curvature transitions. +// Provides rounding of corners or rounding that preserves corner points and curves the edges. +// Also provides some 3D rounding functions, and a powerful function for joining +// two prisms together with a rounded fillet at the joint. // Includes: // include // include // FileGroup: Advanced Modeling -// FileSummary: Round path corners, rounded prisms, rounded cutouts in tubes. +// FileSummary: Round path corners, rounded prisms, rounded cutouts in tubes, filleted prism joints ////////////////////////////////////////////////////////////////////// include include diff --git a/screw_drive.scad b/screw_drive.scad index d04378d..a1b63cb 100644 --- a/screw_drive.scad +++ b/screw_drive.scad @@ -1,11 +1,11 @@ ////////////////////////////////////////////////////////////////////// // LibFile: screw_drive.scad -// Recess masks for screw heads +// Masks for Phillips, Torx and square (Robertson) driver holes. // Includes: // include // include // FileGroup: Threaded Parts -// FileSummary: Masks for Phillips/Torx/etc driver holes. +// FileSummary: Masks for Phillips, Torx and square (Robertson) driver holes. ////////////////////////////////////////////////////////////////////// diff --git a/screws.scad b/screws.scad index cec2b38..c21ee20 100644 --- a/screws.scad +++ b/screws.scad @@ -1,6 +1,10 @@ ////////////////////////////////////////////////////////////////////// // LibFile: screws.scad -// Functions and modules for creating metric and UTS standard screws and nuts. +// Functions and modules for creating metric (ISO) and English (UTS) standard screws and nuts. +// Included is a function for calculating the standard dimensions of screws including the +// tolerance values that are required to create clearance so that screws mate properly when they are formed +// precisely. If you can fabricate objects accurately then your screws will mate +// with standard hardware. // Includes: // include // include diff --git a/shapes3d.scad b/shapes3d.scad index 23a5d28..cc721f8 100644 --- a/shapes3d.scad +++ b/shapes3d.scad @@ -4,7 +4,7 @@ // that produce a VNF. Also included are shortcuts cylinders in each orientation and extended versions of // the standard modules that provide roundovers and chamfers. The spheroid() module provides // several different ways to make a sphere, and the text modules let you write text on a path -// so you can place it on a curved object. +// so you can place it on a curved object. A ruler lets you measure objects. // Includes: // include // FileGroup: Basic Modeling diff --git a/structs.scad b/structs.scad index 72b2f96..639100b 100644 --- a/structs.scad +++ b/structs.scad @@ -1,8 +1,8 @@ ////////////////////////////////////////////////////////////////////// // LibFile: structs.scad // This file provides manipulation of "structs". A "struct" is a data structure that -// associates keywords with values and allows you to get and set values -// by keyword. +// associates arbitrary keys with values and allows you to get and set values +// by key. // Includes: // include // include diff --git a/threading.scad b/threading.scad index 361983a..2ce8cfc 100644 --- a/threading.scad +++ b/threading.scad @@ -1,6 +1,7 @@ ////////////////////////////////////////////////////////////////////// // LibFile: threading.scad -// Triangular and Trapezoidal-Threaded Screw Rods and Nuts. +// Provides generic threading support and specialized support for standard triangular (UTS/ISO) threading, +// trapezoidal threading (ACME), pipe threading, buttress threading, square threading and ball screws. // Includes: // include // include @@ -8,7 +9,6 @@ // FileSummary: Various types of threaded rods and nuts. ////////////////////////////////////////////////////////////////////// - // Section: Standard (UTS/ISO) Threading // Module: threaded_rod() diff --git a/vnf.scad b/vnf.scad index b22096e..a0b141d 100644 --- a/vnf.scad +++ b/vnf.scad @@ -3,7 +3,9 @@ // The Vertices'N'Faces structure (VNF) holds the data used by polyhedron() to construct objects: a vertex // list and a list of faces. This library makes it easier to construct polyhedra by providing // functions to construct, merge, and modify VNF data, while avoiding common pitfalls such as -// reversed faces. +// reversed faces. It can find faults in your polyhedrons. Note that this file is for low level manipulation +// of lists of vertices and faces: it can perform some simple transformations on VNF structures +// but cannot perform boolean operations on the polyhedrons represented by VNFs. // Includes: // include // FileGroup: Advanced Modeling diff --git a/walls.scad b/walls.scad index 62bd9c6..04b8b02 100644 --- a/walls.scad +++ b/walls.scad @@ -1,6 +1,6 @@ ////////////////////////////////////////////////////////////////////// // LibFile: walls.scad -// Various wall constructions. +// Walls and structural elements that 3D print without support. // Includes: // include // include diff --git a/wiring.scad b/wiring.scad index 84f0e83..d192ba6 100644 --- a/wiring.scad +++ b/wiring.scad @@ -1,6 +1,6 @@ ////////////////////////////////////////////////////////////////////// // LibFile: wiring.scad -// Rendering for wire bundles +// Rendering for routed wire bundles // Includes: // include // include