Adding Doxygen to your project
One of the most established and popular tools that can generate documentation from C++ sources is Doxygen. And when I say "established", I mean it: the first version was released by Dimitri van Heesch in October 1997. Since then, it has grown immensely, and it is actively supported by over 180 contributors to its repository (https://github.com/doxygen/doxygen).
Doxygen can produce documentation in the following formats:
- HyperText Markup Language (HTML)
- Rich Text Format (RTF)
- Portable Document Format (PDF)
- Lamport's TeX (LaTeX)
- PostScript (PS)
- Unix manual (man pages)
- Microsoft Compiled HTML Help (CHM)
If you decorate your code with comments providing additional information in the format specified by Doxygen, it will be parsed to enrich the output file. What's more, the code structure will be analyzed to produce helpful charts and diagrams. The latter is optional, as it requires an external...
