Skip to content

Expand API documentation for helpers and debug classes#249

Open
TheBeachLab wants to merge 3 commits intogkjohnson:mainfrom
TheBeachLab:feature/improve-docs
Open

Expand API documentation for helpers and debug classes#249
TheBeachLab wants to merge 3 commits intogkjohnson:mainfrom
TheBeachLab:feature/improve-docs

Conversation

@TheBeachLab
Copy link
Copy Markdown

Summary

Addresses #72 — expands documentation for underdocumented classes.

  • OperationDebugData: Added usage example, documented triangleIntersectsA/triangleIntersectsB properties
  • Evaluator: Added .debug and .attributes property docs
  • HalfEdgeMap: Added class description (was just "TODO")
  • HalfEdgeHelper: Documented .straightEdges and .displayDisconnectedEdges properties, fixed class name (was HalfEdgeMapHelper)
  • PointsHelper: Added constructor signature and .color property
  • EdgesHelper: Added .color property
  • TriangleSetHelper: Added .color and .side properties

Test Plan

  • README renders correctly on GitHub
  • No code changes — documentation only

Replaces CDTTriangleSplitter with a polygon-aware approach that groups
split sub-triangles into regions for bulk classification, reducing
raycasts and enabling symmetric edge matching across CSG boundaries.
5-task TDD plan: create PolygonSplitter with flood-fill polygon
grouping, wire into Evaluator, update split triangle operations for
bulk classification, add canonical edge sharing, verify with benchmarks.
- Add OperationDebugData usage example and document triangleIntersectsA/B
- Add Evaluator .debug and .attributes properties
- Document HalfEdgeMap description
- Add HalfEdgeHelper .straightEdges and .displayDisconnectedEdges
- Add .color property to PointsHelper, EdgesHelper, TriangleSetHelper
- Add TriangleSetHelper .side property
- Add PointsHelper constructor signature
- Fix HalfEdgeMapHelper name to HalfEdgeHelper
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant