Merge pull request #1129 from revarbat/revarbat_dev

Synopses, etc for modular_hose.scad, nema_steppers.scad, polyhedra.scad

modular_hose.scad

@@ -118,7 +118,11 @@ _big_end = [
 
 _hose_waist = [1.7698, 1.8251, 3.95998];
 
+
 // Module: modular_hose()
+// Synopsis: Creates modular hose parts.
+// Topics: Modular Hose, Parts
+// See Also: modular_hose_radius(), tube()
 // Usage:
 //    modular_hose(size, type, [clearance], [waist_len], [anchor], [spin], [orient]) [ATTACHMENTS];
 // Description:
@@ -186,6 +190,9 @@ module modular_hose(size, type, clearance=0, waist_len, anchor=BOTTOM, spin=0,or
 
 
 // Function: modular_hose_radius()
+// Synopsis: Returns the waist radius of the given modular hose size.
+// Topics: Modular Hose, Parts
+// See Also: modular_hose(), tube()
 // Usage:
 //   r = modular_hose_radius(size, [outer]);
 // Description:
@@ -219,4 +226,6 @@ function modular_hose_radius(size, outer=false) =
   )
   outer ? b[1][0] : b[0][0];
 
+
+
 // vim: expandtab tabstop=4 shiftwidth=4 softtabstop=4 nowrap

nema_steppers.scad

@@ -13,9 +13,11 @@
 
 
 // Module: nema_stepper_motor()
+// Synopsis: Creates a NEMA standard stepper motor model.
+// Topics: Parts, Motors
+// See Also: nema_stepper_motor(), nema_mount_mask()
 // Usage:
 //   nema_stepper_motor(size, h, shaft_len, [$slop=], ...) [ATTACHMENTS];
-// Topics: Parts, Motors
 // Description:
 //   Creates a model of a NEMA standard stepper motor.
 // Arguments:
@@ -34,7 +36,6 @@
 //   "plinth" = Anchor relative to the plinth.
 //   "body" = Anchor relative to the motor body.
 //   "screws" = Anchor relative to the screw hole centers.  ie: TOP+RIGHT+FRONT is the center-top of the front-right screwhole.
-// See Also: nema_stepper_motor(), nema_mount_mask()
 // Examples:
 //   nema_stepper_motor(size=8, h=24, shaft_len=15);
 //   nema_stepper_motor(size=11, h=24, shaft_len=20);
@@ -117,9 +118,11 @@ module nema_stepper_motor(size=17, h=24, shaft_len=20, details=true, atype="body
 
 
 // Module: nema_mount_mask()
+// Synopsis: Creates a standard NEMA mount holes mask.
+// Topics: Parts, Motors
+// See Also: nema_stepper_motor(), nema_mount_mask()
 // Usage:
 //   nema_mount_mask(size, depth, l, [$slop], ...);
-// Topics: Parts, Motors
 // Description: Creates a mask to use when making standard NEMA stepper motor mounts.
 // Arguments:
 //   size = The standard NEMA motor size to make a mount for.
@@ -133,7 +136,6 @@ module nema_stepper_motor(size=17, h=24, shaft_len=20, details=true, atype="body
 // Anchor Types:
 //   "full" = Anchor relative the full mask.
 //   "screws" = Anchor relative to the screw hole centers.  ie: TOP+RIGHT+FRONT is the center-top of the front-right screwhole.
-// See Also: nema_stepper_motor(), nema_mount_mask()
 // Examples:
 //   nema_mount_mask(size=14, depth=5, l=5);
 //   nema_mount_mask(size=17, depth=5, l=5);
@@ -183,6 +185,9 @@ module nema_mount_mask(size, depth=5, l=5, atype="full", anchor=CENTER, spin=0,
 
 
 // Function: nema_motor_info()
+// Synopsis: Returns dimension info for a given NEMA motor size.
+// Topics: Parts, Motors
+// See Also: nema_stepper_motor(), nema_mount_mask()
 // Usage:
 //   info = nema_motor_info(size);
 // Description:

polyhedra.scad

@@ -37,6 +37,9 @@ function _unique_groups(m) = [
 
 
 // Module: regular_polyhedron()
+// Synopsis: Creates a regular polyhedron with optional rounding.
+// Topics: Polyhedra, Shapes, Parts
+// See Also: regular_polyhedron_info()
 // Usage: Selecting a polyhedron
 //   regular_polyhedron([name],[index=],[type=],[faces=],[facetype=],[hasfaces=],...) [CHILDREN];
 // Usage: Controlling the size and position of the polyhedron
@@ -550,6 +553,9 @@ _stellated_polyhedra_ = [
 
 
 // Function: regular_polyhedron_info()
+// Synopsis: Returns info used to create a regular polyhedron.
+// Topics: Polyhedra, Shapes, Parts
+// See Also: regular_polyhedron()
 //
 // Usage:
 //   info = regular_polyhedron_info(info, ...);