Installing Doxygen for Linyx

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

• Before installing, it is a good practice to update the package list:

sudo apt-get update

• Use the following command to install it:

sudo apt install doxygen

• To verify the installation, open a terminal and run:

doxygen --version

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.

---

Linux Configuration | Wiki Home