Skip to content

Commit 59bf523

Browse files
committed
Lots of docs tweaks for openscad-docsgen v2
1 parent 4cb59d9 commit 59bf523

51 files changed

Lines changed: 148 additions & 195 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
DocsDirectory: BOSL2.wiki/
2+
TargetProfile: githubwiki
3+
ProjectName: The Belfry OpenScad Library, v2. (BOSL2)
4+
GenerateDocs: Files, TOC, Index, Topics, CheatSheet
25
IgnoreFiles:
36
affine.scad
47
foo.scad
@@ -8,43 +11,44 @@ IgnoreFiles:
811
tmp_*.scad
912
PrioritizeFiles:
1013
transforms.scad
11-
distributors.scad
12-
mutators.scad
1314
attachments.scad
14-
drawing.scad
1515
shapes2d.scad
1616
shapes3d.scad
17+
drawing.scad
1718
masks2d.scad
1819
masks3d.scad
20+
distributors.scad
21+
partitions.scad
22+
mutators.scad
23+
paths.scad
24+
regions.scad
25+
vnf.scad
26+
beziers.scad
27+
rounding.scad
28+
skin.scad
29+
turtle3d.scad
1930
math.scad
20-
comparisons.scad
21-
coords.scad
2231
linalg.scad
23-
lists.scad
2432
vectors.scad
2533
quaternions.scad
26-
edges.scad
34+
coords.scad
2735
geometry.scad
2836
trigonometry.scad
29-
hull.scad
30-
paths.scad
31-
regions.scad
32-
vnf.scad
33-
skin.scad
34-
utility.scad
3537
constants.scad
36-
strings.scad
3738
version.scad
38-
beziers.scad
39-
knurling.scad
40-
partitions.scad
41-
rounding.scad
42-
threading.scad
43-
turtle3d.scad
39+
comparisons.scad
40+
lists.scad
41+
utility.scad
42+
strings.scad
4443
structs.scad
4544
fnliterals.scad
45+
threading.scad
46+
screws.scad
47+
metric_screws.scad
48+
bottlecaps.scad
49+
screw_drive.scad
4650
DefineHeader(BulletList): Side Effects
47-
DefineHeader(Table:Anchor Name|Position): Extra Anchors
48-
DefineHeader(Table:Name|Definition): Terminology
51+
DefineHeader(Table;Headers=Anchor Name|Position): Extra Anchors
52+
DefineHeader(Table;Headers=Name|Definition): Terminology
4953
DefineHeader(BulletList): Requirements
5054

attachments.scad

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
// are both written to support attachment. Also included in this file are the tools to make your own "attachable" objects.
88
// Includes:
99
// include <BOSL2/std.scad>
10+
// FileGroup: Basic Modeling
11+
// FileSummary: Positioning objects on or relative to other objects. Making your own objects support attachment.
12+
// FileFootnotes: STD=Included in std.scad
1013
//////////////////////////////////////////////////////////////////////
1114

1215

beziers.scad

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
// Includes:
55
// include <BOSL2/std.scad>
66
// include <BOSL2/beziers.scad>
7+
// FileGroup: Advanced Modeling
8+
// FileSummary: Support for bezier curves and surfaces.
79
//////////////////////////////////////////////////////////////////////
810

911
// Terminology:

bottlecaps.scad

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
// Includes:
55
// include <BOSL2/std.scad>
66
// include <BOSL2/bottlecaps.scad>
7+
// FileGroup: Threaded Parts
8+
// FileSummary: Standard bottle caps and necks.
79
//////////////////////////////////////////////////////////////////////
810

911

comparisons.scad

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
// Functions for comparisons with lists, ordering and sorting
44
// Includes:
55
// include <BOSL2/std.scad>
6+
// FileGroup: Data Management
7+
// FileSummary: Comparisons and sorting.
8+
// FileFootnotes: STD=Included in std.scad
69
//////////////////////////////////////////////////////////////////////
710

811

coords.scad

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
// Coordinate transformations and coordinate system conversions.
44
// Includes:
55
// include <BOSL2/std.scad>
6+
// FileGroup: Math
7+
// FileSummary: Conversions between coordinate systems.
8+
// FileFootnotes: STD=Included in std.scad
69
//////////////////////////////////////////////////////////////////////
710

811

cubetruss.scad

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
// Includes:
55
// include <BOSL2/std.scad>
66
// include <BOSL2/cubetruss.scad>
7+
// FileGroup: Parts
8+
// FileSummary: Modular open-framed trusses and joiners.
79
//////////////////////////////////////////////////////////////////////////
810

911
$cubetruss_size = 30;

distributors.scad

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
// Functions and modules to distribute children or copies of children.
44
// Includes:
55
// include <BOSL2/std.scad>
6+
// FileGroup: Basic Modeling
7+
// FileSummary: Shortcuts for translation, rotation, etc. Can act on geometry, paths, or can return a matrix.
8+
// FileFootnotes: STD=Included in std.scad
69
//////////////////////////////////////////////////////////////////////
710

811

drawing.scad

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
// and helix() produces helix paths.
99
// Includes:
1010
// include <BOSL2/std.scad>
11+
// FileGroup: Basic Modeling
12+
// FileSummary: Attachable cubes, cylinders, spheres, ruler, and text. Many can produce a VNF.
13+
// FileFootnotes: STD=Included in std.scad
1114
//////////////////////////////////////////////////////////////////////
1215

1316

fnliterals.scad

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
// Includes:
55
// include <BOSL2/std.scad>
66
// include <BOSL2/fnliterals.scad>
7-
// DefineHeader(Table:Positional|Definition||Named|Definition): FunctionLiteral Args
7+
// FileGroup: Data Management
8+
// FileSummary: Function Literal Algorithms, and factories for generating function literals for builtin functions.
9+
// DefineHeader(Table;Headers=Positional|Definition||Named|Definition): FunctionLiteral Args
810
//////////////////////////////////////////////////////////////////////
911

1012

0 commit comments

Comments
 (0)