To better document the project as we go along, I've pushed to main a Doxyfile for the doxygen generator, which is cross platform. Right out of the box, it generates some interesting docs. Those docs are placed in ./docs/html/
As part of a much longer series, I'm planning to start documenting the code itself, as well as the API with @jfrancis42 I expect as people touch the code, they should document as they go 😀
Basic instructions can be found in the doxygen manual.
I'd recommend the /** some description */ method.
I don't expect massive quantities of docs, just enough that somebody can figure out what's going on.
Thanks!
To better document the project as we go along, I've pushed to main a Doxyfile for the doxygen generator, which is cross platform. Right out of the box, it generates some interesting docs. Those docs are placed in ./docs/html/
As part of a much longer series, I'm planning to start documenting the code itself, as well as the API with @jfrancis42 I expect as people touch the code, they should document as they go 😀
Basic instructions can be found in the doxygen manual.
I'd recommend the /** some description */ method.
I don't expect massive quantities of docs, just enough that somebody can figure out what's going on.
Thanks!