Open jrlanglois opened 3 years ago
Yea, I looked at Doxygen; I realize it's a standard in C++ projects but this project very fluidly spans JavaScript and C++, and I don't know Doxygen well enough to know if it covers both sides or how to integrate the C++ side into some broader docs for the JavaScript side. So, I adopted a plan of just manually documenting to ensure cohesiveness across the language boundary, which is what #12 aims to cover
No worries. I'll hook you up!
Awesome 😁 sounds great!
Edit: we just started rolling out a new documentation platform with docsify
in the docs/
directory. If we can integrate doxygen into that, that'd be ideal
Oh! That sounds good. Just an fyi that Doxygen supports JS - I'll see if I can work that in somehow, alongside some README.md or whatever to explain how to go about generating the documentation with it.
Relates to https://github.com/nick-thompson/blueprint/issues/12