Awesome Doxygen StyleJul 07, 2021
Doxygen is the de-facto standard tool for C++ API documentation. It comes with a whole bunch of useful features such as auto-generated API documentation from annotated sources or automatic cross-references.
Unfortunately, the default Doxygen HTML output is quite dated, both in terms of visual style as well as navigation. Here’s an example:
Especially on mobile devices the resulting pages are notoriously difficult to navigate1.
While this is arguably better than the default, it is far away from perfect.
Some of the advantages are
- a modern look and feel
- simple integration and customization
- improved mobile usability
- dark mode support
I immediately adopted it for PMP. Here’s a snapshot:
Personally, I think this is indeed an awesome improvement.
If you are looking for a more modern style for your Doxygen docs, just give doxygen-awesome-css a try. Installation is super easy, you basically only need to include the additional CSS files into your repository and tell Doxygen to use them through the
Check out the project website for more details. Hope this helps.
One might argue that mobile is not so important for API documentation. Fair enough. However, Doxygen can also used to build complete project websites including landing pages, tutorials, or high-level documentation. Therefore, accessibility on mobile is still an important aspect. ↩