search

n-wach / protractr

Geometric Constraint Solver
https://n-wach.github.io/protractr
53 stars 9 forks source link

Consider adding class/method documentation #6

Closed pconrad closed 5 years ago

pconrad commented 5 years ago

It's always much easier to do that if it's autogenerated.

Here's one possible option: https://typedoc.org/guides/doccomments/

There may be others.

n-wach commented 5 years ago

TypeDoc appears to be the standard--seems to be working well. I'll add more docstrings over time...