DocsDirectory: api.wiki/
TargetProfile: githubwiki
ProjectName: BSPPFit --- Parametric BSPP Pipe Fittings
GenerateDocs: Files, TOC, Index, Topics, CheatSheet, Sidebar

# Only the library source carries API docs. The dedicated oracle models
# and the test harness are excluded.
IgnoreFiles:
  bsppfitTest.scad
  Cap.scad
  Elbow.scad
  HexBush.scad
  HoseTail.scad
  Manifold.scad
  Nipple.scad
  Pipe.scad
  Plug.scad
  Reducer.scad
  Union.scad

PrioritizeFiles:
  bsppfit.scad

# SynTags give meaning to the "// SynTags:" line on each symbol. The full
# BOSL2 set is defined so our tags always resolve (a used-but-undefined tag
# makes openscad-docsgen crash, not warn). BSPPFit modules use Geom.
DefineSynTags:
  Ext = Extends the OpenSCAD built-in of the same name.
  Geom = Can return geometry.
  Mat = Can return a transformation matrix.
  MatList = Can return a list of transformation matrices.
  Path = Can return a Path.
  PathList = Can return a list of Paths.
  Region = Can return a Region.
  RegList = Can return a list of Regions.
  Trans = Can transform its children.
  VNF = Can return a VNF.
