react-juce icon indicating copy to clipboard operation
react-juce copied to clipboard

Published 20 hours ago • verified publisher icon JoshMarler

Add Doxygen+GraphViz Support

Open jrlanglois opened this issue 4 years ago • 4 comments

Relates to https://github.com/nick-thompson/blueprint/issues/12

jrlanglois avatar Sep 17 '20 15:09 jrlanglois

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

nick-thompson avatar Sep 20 '20 15:09 nick-thompson

No worries. I'll hook you up!

jrlanglois avatar Sep 20 '20 16:09 jrlanglois

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

nick-thompson avatar Sep 20 '20 17:09 nick-thompson

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.

jrlanglois avatar Sep 20 '20 22:09 jrlanglois