search

cannontwo / cannon

Lifetime repository
https://cannontwo.com/cannon/
MIT License
0 stars 0 forks source link

Integrate Doxygen #84

Closed cannontwo closed 3 years ago

cannontwo commented 3 years ago

Now that this repository is getting larger, it would be good to have comprehensive documentation. This will also allow me to automatically keep track of TODO comments, with a small bit of setup.

cannontwo commented 3 years ago

Use Doxygen+Breathe+Exhale+Sphinx workflow documented here

cannontwo commented 3 years ago

See also https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

cannontwo commented 3 years ago

Once this is done, larger TODOs should be turned into issues.

cannontwo commented 3 years ago

Mostly resolved by a4fc25483b4e57d91b34f42a7b0aad8b44a3b3e0. Still want to set up a Github Pages for this repository and point it at the generated documentation.

cannontwo commented 3 years ago

Resolved and live at https://cannontwo.com/cannon/