file summary improvements and tweaks

This commit is contained in:
Adrian Mariano 2022-04-21 00:26:20 -04:00
parent 5c4032f054
commit 9433b05a65
22 changed files with 45 additions and 28 deletions

View file

@ -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 <BOSL2/std.scad>
// include <BOSL2/bottlecaps.scad>

View file

@ -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 <BOSL2/std.scad>
// 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
//////////////////////////////////////////////////////////////////////

View file

@ -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 <BOSL2/std.scad>
// FileSummary: Constants provided by the library
//////////////////////////////////////////////////////////////////////
// a value that the user should never enter randomly;

View file

@ -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 <BOSL2/std.scad>
// 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
//////////////////////////////////////////////////////////////////////

View file

@ -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 <BOSL2/std.scad>
// FileGroup: Basic Modeling

View file

@ -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 <BOSL2/std.scad>
// include <BOSL2/gears.scad>

View file

@ -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 <BOSL2/std.scad>
// include <BOSL2/hingesnaps.scad>

View file

@ -1,6 +1,6 @@
//////////////////////////////////////////////////////////////////////
// LibFile: linear_bearings.scad
// Linear Bearing clips/holders.
// Mounts for LMxUU style linear bearings.
// Includes:
// include <BOSL2/std.scad>
// include <BOSL2/linear_bearings.scad>

View file

@ -5,7 +5,7 @@
// Includes:
// include <BOSL2/std.scad>
// 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
//////////////////////////////////////////////////////////////////////

View file

@ -5,7 +5,7 @@
// include <BOSL2/std.scad>
// include <BOSL2/modular_hose.scad>
// FileGroup: Parts
// FileSummary: Modular flexible hose parts.
// FileSummary: Modular flexible hose segments.
//////////////////////////////////////////////////////////////////////////
// Section: Modular Hose Parts

View file

@ -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 <BOSL2/std.scad>
// include <BOSL2/nema_steppers.scad>

View file

@ -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

View file

@ -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:

View file

@ -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 <BOSL2/std.scad>
// include <BOSL2/rounding.scad>
// 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 <beziers.scad>
include <structs.scad>

View file

@ -1,11 +1,11 @@
//////////////////////////////////////////////////////////////////////
// LibFile: screw_drive.scad
// Recess masks for screw heads
// Masks for Phillips, Torx and square (Robertson) driver holes.
// Includes:
// include <BOSL2/std.scad>
// include <BOSL2/screw_drive.scad>
// FileGroup: Threaded Parts
// FileSummary: Masks for Phillips/Torx/etc driver holes.
// FileSummary: Masks for Phillips, Torx and square (Robertson) driver holes.
//////////////////////////////////////////////////////////////////////

View file

@ -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 <BOSL2/std.scad>
// include <BOSL2/screws.scad>

View file

@ -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 <BOSL2/std.scad>
// FileGroup: Basic Modeling

View file

@ -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 <BOSL2/std.scad>
// include <BOSL2/structs.scad>

View file

@ -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 <BOSL2/std.scad>
// include <BOSL2/threading.scad>
@ -8,7 +9,6 @@
// FileSummary: Various types of threaded rods and nuts.
//////////////////////////////////////////////////////////////////////
// Section: Standard (UTS/ISO) Threading
// Module: threaded_rod()

View file

@ -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 <BOSL2/std.scad>
// FileGroup: Advanced Modeling

View file

@ -1,6 +1,6 @@
//////////////////////////////////////////////////////////////////////
// LibFile: walls.scad
// Various wall constructions.
// Walls and structural elements that 3D print without support.
// Includes:
// include <BOSL2/std.scad>
// include <BOSL2/walls.scad>

View file

@ -1,6 +1,6 @@
//////////////////////////////////////////////////////////////////////
// LibFile: wiring.scad
// Rendering for wire bundles
// Rendering for routed wire bundles
// Includes:
// include <BOSL2/std.scad>
// include <BOSL2/wiring.scad>