Installing Doxygen For Windows - iat-cener/tonatiuh GitHub Wiki
Doxygen
Doxygen is a documentation generator for C++, C, Java, Objective-C, Python, IDL (versiones Corba y Microsoft), PHP, C#, and D. It is valid for Unix, Windows and Mac OS X. Doxygen is the acronym of dox(document) gen(generator), source code documentation generator.
Installation
The doxygen sources and binaies are available on the doxygen download web page. For Windows you can download doxygen binaries on a zip and extract them at C:\msys64\doxygen.
Alternativelly, use the MSYS2 system to install the corresponding package for doxygen.
pacman -S mingw-w64-ucrt-x86_64-doxygen
Configure VS configuration for Doxygen
The creation of documentation has two step:
- Create the configuration step and configure it, and
- Generate the documentation
The first time that creates the documentation, it is required to create a configuration file by executing the command:
doxygen -g
After that, a "Doxyfile" is created. Modify this document to define the project name, logo, file patterns, output folder, etc. After saving the changes execute:
doxygen Doxyfile
Now, the documentation is available in the path defined.
| images/developersguide/windows/DoxygenDocumentationHTML.jpg |
|---|
| Figure 1. Example of the documentation generated for Tonatiuh. |
