implemented typedoc documentation

[msantic]

Addresses #906

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.40%. Comparing base (d437097) to head (da5ea2e).
Report is 90 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #907      +/-   ##
==========================================
- Coverage   91.84%   88.40%   -3.44%     
==========================================
  Files          37       62      +25     
  Lines        4976     8660    +3684     
  Branches        0     1059    +1059     
==========================================
+ Hits         4570     7656    +3086     
- Misses        406     1004     +598     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[elalish]

Any trouble with signing the CLA? It should be automatic as an individual.

[elalish]

It'd be great if you can take a stab at it - I think you'll probably just have to modify deploy.yml to build that site and put it in another directory under ./public. I'll take care of trouble-shooting it when we merge, since there will inevitably be some path error with the website the first time it deploys.

I realized we didn't copy our docs for Mesh into our TS declarations, which is why they're missing in your website. Would you mind copying them over and checking the page gets generated correctly? While you're at it, it would be great to have a second set of eyes on the rest of those doc comments in case they've gotten out of sync with the C++.

[msantic]

It'd be great if you can take a stab at it - I think you'll probably just have to modify deploy.yml to build that site and put it in another directory under ./public. I'll take care of trouble-shooting it when we merge, since there will inevitably be some path error with the website the first time it deploys.

I'm doing GitHub Pages&Workflow for the first time so hopefully I've done it ok. You can check it out...

I realized we didn't copy our docs for Mesh into our TS declarations, which is why they're missing in your website. Would you mind copying them over and checking the page gets generated correctly? While you're at it, it would be great to have a second set of eyes on the rest of those doc comments in case they've gotten out of sync with the C++.
Sure, no problem. Still learning the codebase so could you please point me where C++ Mesh definition is (the one from manifold-encapsulated-types.d.ts)? There are:

• MeshGl in manifold.hr https://github.com/msantic/manifold/blob/0158466c87a1c91fa06143ec37fc0a67457e19c6/src/manifold/include/manifold.h#L46 and Mesh
• also Mesh in public.h https://github.com/msantic/manifold/blob/0158466c87a1c91fa06143ec37fc0a67457e19c6/src/utilities/include/public.h#L136

I see also that methods: getCircularSegments, resetToCircularDefaults, setCircularSegments and setMinCircularEdgeLength doesn't have comments. I will fixed them as well.

[elalish]

Thanks! The TS Mesh is MeshGL - the old C++ Mesh is deprecated.

[msantic]

@elalish I went through the entire doc comments and already fixed a few. Here’s what is still missing:

• resetToCircularDefaults - ResetToDefaults missing doc in C++, public.h:579
• Mesh methods:
• merge(): boolean;
• verts(tri: number): SealedUint32Array<3>;
• position(vert: number): SealedFloat32Array<3>;
• extras(vert: number): Float32Array;
• tangent(halfedge: number): SealedFloat32Array<4>;
• transform(run: number): Mat4;

[elalish]

Great, thank you! Are those function definitions missing entirely? Feel free to add them.

[msantic]

@elalish Yes, the definitions are entirely missing. I could try to add doc comments, but I think it would be better for someone more familiar with the internal logic to do it.