search

kvasir-io / Kvasir

C++ Metaprogramming library enabling better static checking and register abstraction in embedded software
Apache License 2.0
409 stars 40 forks source link

Run doxygen and publish to gh-pages branch #118

Open LegalizeAdulthood opened 6 years ago

LegalizeAdulthood commented 6 years ago

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.

odinthenerd commented 6 years ago

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.

LegalizeAdulthood commented 6 years ago

Have you looked at doxypress? It uses Clang as the front end, so should have better luck at parsing modern C++.

LegalizeAdulthood commented 6 years ago

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.

odinthenerd commented 6 years ago

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.