How to quickly create doxygen documentation in Ubuntu

Installing

$ sudo apt install doxygen
$ sudo apt install graphviz

Configuring

Go to the directory or sub-directory of your project which you want to document and create file with name Doxyfile with following content (or execute doxygen -g to create template file having default settings)

Doxyfile

This file configures output to be placed in the Documentation directory under your source directory.

Generating

Open shell and go to the folder where Doxyfile is located.

Then execute doxygen.

Doxygen will scan all the files in sub-directories of the selected directory. Generated documentation will be placed into Documentation directory inside selected one.

Setting up web server

$ sudo apt-get update
$ sudo apt-get install apache2

Update Doxyfile to direct output to the web-server directory /var/www/

Doxyfile

$ sudo systemctl status apache2
$ sudo systemctl restart apache2

Setting up cron task

Put into /etc/cron.daily a script pulling repository and starting doxygen with Doxyfile.

How to set up cron task on Ubuntu

How To Install the Apache Web Server on Ubuntu 16.04

How to quickly create documentation by Doxygen in Windows

How to quickly create documentation by Doxygen in Windows

Step 1

Install Doxygen from http://www.stack.nl/~dimitri/doxygen/download.html

Install Graphviz from http://www.graphviz.org/download/

Step 2

Go to the directory or sub-directory of your project which you want to document and create file with name Doxyfile with following content (or execute doxygen -g to create template file having default settings)

Doxyfile

Step 3

Open windows command prompt and go to the folder mentioned above.

Then execute doxygen.

Doxygen will scan all the files in sub-directories of the selected directory. Generated documentation will be placed into Documentation directory inside selected one.

If Doxygen isn’t started add path to its binary to the system variable Path.

Adding path to Doxygen to the system variable Path
Adding path to Doxygen to the system variable Path.

How to quickly create doxygen documentation in Ubuntu