docs_gen.py now shows more docs errors.

This commit is contained in:
Garth Minette
2020-07-27 15:15:34 -07:00
parent bda538defa
commit b5d465cf1e
18 changed files with 245 additions and 221 deletions

View File

@@ -42,7 +42,7 @@ function _unique_groups(m) = [
//
// Description:
// Creates a regular polyhedron with optional rounding. Children are placed on the polyhedron's faces.
//
// .
// **Selecting the polyhedron:**
// You constrain the polyhedra list by specifying different characteristics, that must all be met
// * `name`: e.g. `"dodecahedron"` or `"pentagonal icositetrahedron"`
@@ -54,13 +54,13 @@ function _unique_groups(m) = [
// * hasfaces: The list of vertex counts for faces; at least one listed type must appear:
// * `hasfaces = 3`: polygon has at least one triangular face
// * `hasfaces = [5,6]`: polygon has a hexagonal or a pentagonal face
//
// .
// The result is a list of selected polyhedra. You then specify `index` to choose which one of the
// remaining polyhedra you want. If you don't give `index` the first one on the list is created.
// Two examples:
// * `faces=12, index=2`: Creates the 3rd solid with 12 faces
// * `type="archimedean", faces=14`: Creates the first archimedean solid with 14 faces (there are 3)
//
// .
// **Choosing the size of your polyhedron:**
// The default is to create a polyhedron whose smallest edge has length 1. You can specify the
// smallest edge length with the size option. Alternatively you can specify the size of the
@@ -70,18 +70,18 @@ function _unique_groups(m) = [
// For the platonic solids every face meets the inscribed sphere and every corner touches the
// circumscribed sphere. For the Archimedean solids the inscribed sphere will touch only some of
// the faces and for the Catalan solids the circumscribed sphere meets only some of the corners.
//
// .
// **Orientation:**
// Orientation is controled by the facedown parameter. Set this to false to get the canonical orientation.
// Set it to true to get the largest face oriented down. If you set it to a number the module searches for
// a face with the specified number of vertices and orients that face down.
//
// .
// **Rounding:**
// If you specify the rounding parameter the module makes a rounded polyhedron by first creating an
// undersized model and then expanding it with `minkowski()`. This only produces the correct result
// if the in-sphere contacts all of the faces of the polyhedron, which is true for the platonic, the
// catalan solids and the trapezohedra but false for the archimedean solids.
//
// .
// **Children:**
// The module places children on the faces of the polyhedron. The child coordinate system is
// positioned so that the origin is the center of the face. If `rotate_children` is true (default)
@@ -90,7 +90,7 @@ function _unique_groups(m) = [
// With `repeat=false` each child is used once. You can specify `draw=false` to suppress drawing of
// the polyhedron, e.g. to use for `difference()` operations. The module sets various parameters
// you can use in your children (see the side effects list below).
//
// .
// **Stellation:**
// Technically stellation is an operation of shifting the polyhedron's faces to produce a new shape
// that may have self-intersecting faces. OpenSCAD cannot handle self-intersecting faces, so we
@@ -99,7 +99,7 @@ function _unique_groups(m) = [
// no stellation is performed. Otherwise stellate gives the pyramid height as a multiple of the
// edge length. A negative pyramid height can be used to perform excavation, where a pyramid is
// removed from each face.
//
// .
// **Special Polyhedra:**
// These can be selected only by name and may require different parameters, or ignore some standard
// parameters.
@@ -112,7 +112,7 @@ function _unique_groups(m) = [
// * `h`: Distance from the center to the apex.
// * `r`: Radius of the polygon that defines the equatorial vertices.
// * `d`: Diameter of the polygon that defines the equatorial vertices.
//
// .
// * Named stellations: various polyhedra such as the Kepler-Poinsot solids are stellations with
// specific pyramid heights. To make them easier to generate you can specify them by name.
// This is equivalent to giving the name of the appropriate base solid and the magic stellate