Document the c++ code using Doxygen

Question

Document the c++ code using Doxygen

Opened this issue 3 years ago · 5 comments

The code is not currently documented. This should be done to allow for continuity or for onboarding of new members.

Answer 1 · 2022-02-04T13:52:14.000Z

Link to download the Doxygen tool (Generate documentation from Doxygen-like commented code; helper to produce such comments are available as plugins in VS Code)

Answer 2 · 2022-02-04T14:55:33.000Z

My Doxygen setup is ready! Now the code itself has to be commented with Doxygen style (the whole manual is also useful for detailed points, such as formulas)

Answer 3 · 2022-02-07T09:30:37.000Z

Doxygen displayed in Github

Answer 4 · 2022-02-07T10:58:17.000Z

Customize Doxygen
(Bottom of the page : interface XML output with Sphinx for Python)

Answer 5 · 2022-02-13T08:39:00.000Z

Would it be possible to setup a GitHub Pages or something similar so that the documentation is visible directly online without having to clone the code locally? From what I read it should be possible and would make things more accessible for team members that don't necessarily need/want to clone the repository.