mirror of
https://github.com/BelfrySCAD/BOSL2.git
synced 2024-12-29 00:09:41 +00:00
doc fixes
This commit is contained in:
parent
26fa464ce1
commit
8861464dbb
5 changed files with 12 additions and 12 deletions
|
@ -750,7 +750,7 @@ module arc(N, r, angle, d, cp, points, width, thickness, start, wedge=false, anc
|
|||
// Helix will be right handed if turns is positive and left handed if it is negative.
|
||||
// The angle is calculateld based on the radius at the base of the helix.
|
||||
// Arguments:
|
||||
// h|l = Height/length of helix, zero for a flat spiral
|
||||
// h/l = Height/length of helix, zero for a flat spiral
|
||||
// ---
|
||||
// turns = Number of turns in helix, positive for right handed
|
||||
// angle = helix angle
|
||||
|
|
12
joiners.scad
12
joiners.scad
|
@ -675,9 +675,9 @@ function _pin_size(size) =
|
|||
// Arguments:
|
||||
// size = text string to select from a list of predefined sizes, one of "standard", "small", or "tiny".
|
||||
// pointed = set to true to get a pointed pin, false to get one with a rounded end. Default: true
|
||||
// r|radius = radius of the pin
|
||||
// d|diameter = diameter of the pin
|
||||
// l|length = length of the pin
|
||||
// r/radius = radius of the pin
|
||||
// d/diameter = diameter of the pin
|
||||
// l/length = length of the pin
|
||||
// nub_depth = the distance of the nub from the base of the pin
|
||||
// snap = how much snap the pin provides (the nub projection)
|
||||
// thickness = thickness of the pin walls
|
||||
|
@ -740,9 +740,9 @@ module snap_pin(size,r,radius,d,diameter, l,length, nub_depth, snap, thickness,
|
|||
// Arguments:
|
||||
// size = text string to select from a list of predefined sizes, one of "standard", "small", or "tiny".
|
||||
// pointed = set to true to get a pointed pin, false to get one with a rounded end. Default: true
|
||||
// r|radius = radius of the pin
|
||||
// d|diameter = diameter of the pin
|
||||
// l|length = length of the pin
|
||||
// r/radius = radius of the pin
|
||||
// d/diameter = diameter of the pin
|
||||
// l/length = length of the pin
|
||||
// nub_depth = the distance of the nub from the base of the pin
|
||||
// snap = how much snap the pin provides (the nub projection)
|
||||
// fixed = if true the pin cannot rotate, if false it can. Default: true
|
||||
|
|
|
@ -195,7 +195,7 @@ include <structs.scad>
|
|||
// path = list of 2d or 3d points defining the path to be rounded.
|
||||
// method = rounding method to use. Set to "chamfer" for chamfers, "circle" for circular rounding and "smooth" for continuous curvature 4th order bezier rounding. Default: "circle"
|
||||
// ---
|
||||
// radius|r = rounding radius, only compatible with `method="circle"`. Can be a number or vector.
|
||||
// radius/r = rounding radius, only compatible with `method="circle"`. Can be a number or vector.
|
||||
// cut = rounding cut distance, compatible with all methods. Can be a number or vector.
|
||||
// joint = rounding joint distance, compatible with `method="chamfer"` and `method="smooth"`. Can be a number or vector.
|
||||
// flat = length of the flat edge created by chamfering, compatible with `method="chamfer"`. Can be a number of vector.
|
||||
|
|
|
@ -495,11 +495,12 @@ function cuboid(
|
|||
// Creates a rectangular prismoid shape with optional roundovers and chamfering.
|
||||
// You can only round or chamfer the vertical(ish) edges. For those edges, you can
|
||||
// specify rounding and/or chamferring per-edge, and for top and bottom separately.
|
||||
// If you want to round the bottom or top edges see {{rounded_prism()}}.
|
||||
//
|
||||
// Arguments:
|
||||
// size1 = [width, length] of the bottom end of the prism.
|
||||
// size2 = [width, length] of the top end of the prism.
|
||||
// h|l = Height of the prism.
|
||||
// h/l = Height of the prism.
|
||||
// shift = [X,Y] amount to shift the center of the top end with respect to the center of the bottom end.
|
||||
// ---
|
||||
// rounding = The roundover radius for the vertical-ish edges of the prismoid. If given as a list of four numbers, gives individual radii for each corner, in the order [X+Y+,X-Y+,X-Y-,X+Y-]. Default: 0 (no rounding)
|
||||
|
@ -745,7 +746,7 @@ function octahedron(size=1, anchor=CENTER, spin=0, orient=UP) =
|
|||
// specify rounding and/or chamferring per-edge, and for top and bottom, inside and
|
||||
// outside separately.
|
||||
// Arguments:
|
||||
// h|l = The height or length of the rectangular tube. Default: 1
|
||||
// h/l = The height or length of the rectangular tube. Default: 1
|
||||
// size = The outer [X,Y] size of the rectangular tube.
|
||||
// isize = The inner [X,Y] size of the rectangular tube.
|
||||
// center = If given, overrides `anchor`. A true value sets `anchor=CENTER`, false sets `anchor=UP`.
|
||||
|
|
|
@ -447,8 +447,7 @@ function get_anchor(anchor,center,uncentered=BOT,dflt=CENTER) =
|
|||
// specific, returns half its value, giving the radius. If no radii or diameters are defined,
|
||||
// returns the value of `dflt`. Value specificity order is `r1`, `r2`, `d1`, `d2`, `r`, `d`,
|
||||
// then `dflt`. Only one of `r1`, `r2`, `d1`, or `d2` can be defined at once, or else it errors
|
||||
// out, complaining about conflicting radius/diameter values. Only one of `r` or `d` can be
|
||||
// defined at once, or else it errors out, complaining about conflicting radius/diameter values.
|
||||
// out, complaining about conflicting radius/diameter values.
|
||||
// Arguments:
|
||||
// ---
|
||||
// r1 = Most specific radius.
|
||||
|
|
Loading…
Reference in a new issue