kevin4998
commented
2 years ago Doxygen allows for a range of customizability, one of them being that you can change its appearance by modifying the .css files. So it improve on Doxygen's base design we have considered 4 different themes, created by other developers. From these we currently prefer the dark theme from Doxygen Awesome and would like to set this as the default on our generated API website. Further modifications are possible but are a better fit for later issues/tasks.
:star: Doxygen Awesome (Repository)
This theme is an attemt to update the visuals of doxygen without changing it's overall layout too much.
Doxygen Dark Theme (Repository)
Theme implements dark colors implementation for doxygen documentation generator. Selected colors are inspiration from Sublime Text syntax highligher for C language.
Doxygen Github Markdown Theme (Repository)
Doxygen theme to style HTML output similar to Github Markdown
Doxygen Theme - Flat Design (Repository)
Modern flat layout for Doxygen websites.
In modern time it is now possible to convert our xml comments directly into a readable API website. This provides a central place for people to learn our code without needing to sift through all the sources and figure out all statements. I advise we integrate this website generation into our CX and make it visible for everyone using GitHub Pages.
The generation of this website can be done with tools such as Doxygen (other programs are available).
Request code and examples comments among the team (for non-intuitive systems), since this is an important part of learning how to use a program.