-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Run doxygen and publish to gh-pages branch #118
Comments
doxygen is a bit hard sometimes with heavily templated code. We have been using standardese on some other kvasir projects. lack of documentation is a real problem I agree. |
Have you looked at doxypress? It uses Clang as the front end, so should have better luck at parsing modern C++. |
I'm trying doxypress right now... it's been grinding for several hours, LOL. I think what I need to do is configure it to ignore the 770 MB of generated chip files. |
yes, the sheer volume of generated files needs to change. I think I can generate conan packages for all the chips that just generate on the fly, then you only get the generated files relevant to exactly the chip you are using. |
One way to encourage use of Kvasir is to have documentation as readily accessible as possible.
The wiki seems a little stale and doesn't cover all the information you need.
There is a Doxyfile, but I haven't attempted to run doxygen to see what is produced. If this is the intended way to document the API, then we should regularly run doxygen and push the results to the github pages.
The text was updated successfully, but these errors were encountered: