From c9b475efbc2b93283eedd3da7a5d6019628eee1c Mon Sep 17 00:00:00 2001 From: Revar Desmera Date: Tue, 4 Apr 2023 21:00:31 -0700 Subject: [PATCH] Review linear_bearings.scad and sliders.scad for Usage line syntax. --- linear_bearings.scad | 14 ++++++++++++++ sliders.scad | 12 ++++++------ 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/linear_bearings.scad b/linear_bearings.scad index 7a3fd72..0ea9a72 100644 --- a/linear_bearings.scad +++ b/linear_bearings.scad @@ -18,6 +18,8 @@ include // Synopsis: Creates a generic linear bearing mount clamp. // Topics: Parts, Bearings // See Also: linear_bearing(), lmXuu_info(), ball_bearing() +// Usage: +// linear_bearing_housing(d, l, tab, gap, wall, tabwall, screwsize) [ATTACHMENTS]; // Description: // Creates a model of a clamp to hold a generic linear bearing cartridge. // Arguments: @@ -28,6 +30,7 @@ include // wall = Wall thickness of clamp housing. (Default: 3) // gap = Gap in clamp. (Default: 5) // screwsize = Size of screw to use to tighten clamp. (Default: 3) +// --- // anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `CENTER` // spin = Rotate this many degrees around the Z axis after anchor. See [spin](attachments.scad#subsection-spin). Default: `0` // orient = Vector to rotate top towards, after spin. See [orient](attachments.scad#subsection-orient). Default: `UP` @@ -81,12 +84,15 @@ module linear_bearing_housing(d=15, l=24, tab=7, gap=5, wall=3, tabwall=5, screw // Synopsis: Creates a generic linear bearing cartridge. // Topics: Parts, Bearings // See Also: linear_bearing_housing(), lmXuu_info(), ball_bearing() +// Usage: +// linear_bearing(l, od, id, length) [ATTACHMENTS]; // Description: // Creates a rough model of a generic linear ball bearing cartridge. // Arguments: // l/length = The length of the linear bearing cartridge. // od = The outer diameter of the linear bearing cartridge. // id = The inner diameter of the linear bearing cartridge. +// --- // anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `CENTER` // spin = Rotate this many degrees around the Z axis after anchor. See [spin](attachments.scad#subsection-spin). Default: `0` // orient = Vector to rotate top towards, after spin. See [orient](attachments.scad#subsection-orient). Default: `UP` @@ -112,6 +118,8 @@ module linear_bearing(l, od=15, id=8, length, anchor=CTR, spin=0, orient=UP) { // Synopsis: Creates a standardized LM*UU linear bearing mount clamp. // Topics: Parts, Bearings // See Also: linear_bearing(), linear_bearing_housing(), lmXuu_info(), lmXuu_bearing(), lmXuu_housing(), ball_bearing() +// Usage: +// lmXuu_housing(size, tab, gap, wall, tabwall, screwsize) [ATTACHMENTS]; // Description: // Creates a model of a clamp to hold a standard sized lmXuu linear bearing cartridge. // Arguments: @@ -121,6 +129,7 @@ module linear_bearing(l, od=15, id=8, length, anchor=CTR, spin=0, orient=UP) { // wall = Wall thickness of clamp housing. Default: 3 // gap = Gap in clamp. Default: 5 // screwsize = Size of screw to use to tighten clamp. Default: 3 +// --- // anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `CENTER` // spin = Rotate this many degrees around the Z axis after anchor. See [spin](attachments.scad#subsection-spin). Default: `0` // orient = Vector to rotate top towards, after spin. See [orient](attachments.scad#subsection-orient). Default: `UP` @@ -139,10 +148,13 @@ module lmXuu_housing(size=8, tab=7, gap=5, wall=3, tabwall=5, screwsize=3, ancho // Synopsis: Creates a standardized LM*UU linear bearing cartridge. // Topics: Parts, Bearings // See Also: linear_bearing(), linear_bearing_housing(), lmXuu_info(), lmXuu_bearing(), lmXuu_housing(), ball_bearing() +// Usage: +// lmXuu_bearing(size) [ATTACHMENTS]; // Description: // Creates a model of an lmXuu linear ball bearing cartridge. // Arguments: // size = Standard lmXuu inner size. +// --- // anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `CENTER` // spin = Rotate this many degrees around the Z axis after anchor. See [spin](attachments.scad#subsection-spin). Default: `0` // orient = Vector to rotate top towards, after spin. See [orient](attachments.scad#subsection-orient). Default: `UP` @@ -161,6 +173,8 @@ module lmXuu_bearing(size=8, anchor=CTR, spin=0, orient=UP) { // Synopsis: Returns the sizes of a standard LM*UU linear bearing cartridge. // Topics: Parts, Bearings // See Also: linear_bearing(), linear_bearing_housing(), lmXuu_info(), lmXuu_bearing(), lmXuu_housing(), ball_bearing() +// Usage: +// diam_len = lmXuu_info(size); // Description: // Get dimensional info for a standard metric lmXuu linear bearing cartridge. // Returns `[DIAM, LENGTH]` for the cylindrical cartridge. diff --git a/sliders.scad b/sliders.scad index 323d913..a9ec7bd 100644 --- a/sliders.scad +++ b/sliders.scad @@ -16,10 +16,10 @@ // Synopsis: Creates a V-groove slider. // Topics: Parts, Sliders // See Also: rail() -// Description: -// Creates a slider to match a V-groove rail. // Usage: // slider(l, w, h, [base=], [wall=], [ang=], [$slop=]) [ATTACHMENTS]; +// Description: +// Creates a slider to match a V-groove rail. // Arguments: // l = Length (long axis) of slider. // w = Width of slider. @@ -69,17 +69,17 @@ module slider(l=30, w=10, h=10, base=10, wall=5, ang=30, anchor=BOTTOM, spin=0, // Synopsis: Creates a V-groove rail. // Topics: Parts, Sliders // See Also: slider() -// Description: -// Creates a V-groove rail. // Usage: // rail(l, w, h, [chamfer=], [ang=]) [ATTACHMENTS]; +// Description: +// Creates a V-groove rail. // Arguments: // l = Length (long axis) of slider. // w = Width of slider. // h = Height of slider. -// --- // chamfer = Size of chamfer at end of rail. -// ang = Overhang angle for slider, to facilitate supportless printig. +// ang = Overhang angle for slider, to facilitate supportless printing. +// --- // anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `BOTTOM` // spin = Rotate this many degrees around the Z axis after anchor. See [spin](attachments.scad#subsection-spin). Default: `0` // orient = Vector to rotate top towards, after spin. See [orient](attachments.scad#subsection-orient). Default: `UP`