Monday, March 31, 2014

Doxygen

To use Doxygen to document your source code on Ubuntu, first install doxygen and graphviz:
$ sudo apt-get install doxygen
$ sudo apt-get install graphviz

To generate a doxygen configuration file:
$ doxygen -g # this will generate a configuration file named Doxyfile

Then, edit Doxyfile. In my case, I only modified:
OUTPUT_DIRECTORY = doc
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES

Then run
$ doxygen Doxyfile

Doxygen will automatically find your source code if Doxyfile is placed in the same directory. The resulting documentations are in doc.

For more detail:
http://www.stack.nl/~dimitri/doxygen/index.html

No comments:

Post a Comment