User Tools

Site Tools


cpp:doxygen

This is an old revision of the document!


Doxygen made easy

The idea behind this document is to teach how to document your source code with doxygen without detailing all the features Doxygen has: I will concentrate only in the most convenient documentation examples to get your code well documented and in a consistent way.

The problem with doxygen is that it has may types of special comments blocks, so its very easy to get lost in the details. To overcome this, I will pick for this paper the one I find more convenient and I will give some examples of these blocks with the result you will get.

These examples are made with doxygen version 1.8.11 for Linux.

cpp/doxygen.1484321644.txt.gz · Last modified: 2022/12/02 22:02 (external edit)