Added Synopses to bearings files.

This commit is contained in:
Revar Desmera 2023-03-30 18:30:05 -07:00
parent eb99fbaa46
commit 49e347143f
2 changed files with 21 additions and 0 deletions

View file

@ -13,6 +13,9 @@
// Section: Ball Bearing Models // Section: Ball Bearing Models
// Module: ball_bearing() // Module: ball_bearing()
// Synopsis: Creates a standardized ball bearing assembly.
// Topics: Parts, Bearings
// See Also: linear_bearing(), lmXuu_bearing(), lmXuu_housing()
// Description: // Description:
// Creates a model of a ball bearing assembly. // Creates a model of a ball bearing assembly.
// Arguments: // Arguments:
@ -70,6 +73,9 @@ module ball_bearing(trade_size, id, od, width, shield=true, anchor=CTR, spin=0,
// Function: ball_bearing_info() // Function: ball_bearing_info()
// Synopsis: Creates a standardized ball bearing assembly.
// Topics: Parts, Bearings
// See Also: ball_bearing(), linear_bearing(), lmXuu_info()
// Description: // Description:
// Get dimensional info for a standard metric ball bearing cartridge. // Get dimensional info for a standard metric ball bearing cartridge.
// Returns `[SHAFT_DIAM, OUTER_DIAM, WIDTH, SHIELDED]` for the cylindrical cartridge. // Returns `[SHAFT_DIAM, OUTER_DIAM, WIDTH, SHIELDED]` for the cylindrical cartridge.

View file

@ -15,6 +15,9 @@ include <metric_screws.scad>
// Section: Generic Linear Bearings // Section: Generic Linear Bearings
// Module: linear_bearing_housing() // Module: linear_bearing_housing()
// Synopsis: Creates a generic linear bearing mount clamp.
// Topics: Parts, Bearings
// See Also: linear_bearing(), lmXuu_info(), ball_bearing()
// Description: // Description:
// Creates a model of a clamp to hold a generic linear bearing cartridge. // Creates a model of a clamp to hold a generic linear bearing cartridge.
// Arguments: // Arguments:
@ -75,6 +78,9 @@ module linear_bearing_housing(d=15, l=24, tab=7, gap=5, wall=3, tabwall=5, screw
// Module: linear_bearing() // Module: linear_bearing()
// Synopsis: Creates a generic linear bearing cartridge.
// Topics: Parts, Bearings
// See Also: linear_bearing_housing(), lmXuu_info(), ball_bearing()
// Description: // Description:
// Creates a rough model of a generic linear ball bearing cartridge. // Creates a rough model of a generic linear ball bearing cartridge.
// Arguments: // Arguments:
@ -103,6 +109,9 @@ module linear_bearing(l, od=15, id=8, length, anchor=CTR, spin=0, orient=UP) {
// Section: lmXuu Linear Bearings // Section: lmXuu Linear Bearings
// Module: lmXuu_housing() // Module: lmXuu_housing()
// 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()
// Description: // Description:
// Creates a model of a clamp to hold a standard sized lmXuu linear bearing cartridge. // Creates a model of a clamp to hold a standard sized lmXuu linear bearing cartridge.
// Arguments: // Arguments:
@ -127,6 +136,9 @@ module lmXuu_housing(size=8, tab=7, gap=5, wall=3, tabwall=5, screwsize=3, ancho
// Module: lmXuu_bearing() // Module: lmXuu_bearing()
// 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()
// Description: // Description:
// Creates a model of an lmXuu linear ball bearing cartridge. // Creates a model of an lmXuu linear ball bearing cartridge.
// Arguments: // Arguments:
@ -146,6 +158,9 @@ module lmXuu_bearing(size=8, anchor=CTR, spin=0, orient=UP) {
// Function: lmXuu_info() // Function: lmXuu_info()
// 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()
// Description: // Description:
// Get dimensional info for a standard metric lmXuu linear bearing cartridge. // Get dimensional info for a standard metric lmXuu linear bearing cartridge.
// Returns `[DIAM, LENGTH]` for the cylindrical cartridge. // Returns `[DIAM, LENGTH]` for the cylindrical cartridge.