Introduction to Doxygen

The Doxygen package contains a documentation system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C# and D. This is useful for generating HTML documentation and/or an off-line reference manual from a set of documented source files. There is also support for generating output in RTF, PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.

You can also configure Doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. Used along with GraphViz, you can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.

Package Information

Doxygen Dependencies


Qt-3.3.4, TeX-3.0 and GraphViz

Installation of Doxygen

Install Doxygen by running the following commands:

rm src/unistd.h &&
./configure --prefix /usr --docdir /usr/share/doc &&

This package does not come with a test suite.

Now, as the root user:

make install

If you wish to generate and install the package documentation (note that man pages have already been installed), you must have TeX installed, then issue the following command as the root user:

make install_docs


If you don't have TeX installed but wish to generate and install the HTML documentation (very good docs), issue the following commands:

make docs

Now, as the root user:

install -v -m755 -d /usr/share/doc/doxygen &&
cp -v -R examples html /usr/share/doc/doxygen

Command Explanations

rm src/unistd.h: There is a bug in Flex-2.5.31 which causes make to use this file instead of the system installed version. Removing this file allows the GUI front-end to build successfully. This command is not required if you don't pass the --with-doxywizard parameter (but won't affect the build otherwise).

--with-doxywizard: Use this parameter if Qt is installed and you wish to build the GUI front-end.

Configuring Doxygen

There is no real configuration necessary for the Doxygen package although three additional packages are required if you wish to use extended capabilities. If you need to use the language translation features, you must have Python-2.4.1 installed. If you require formulas to create PDF documentation, then you must have TeX-3.0 installed. If you require formulas to convert PostScript files to bitmaps, then you must have AFPL Ghostscript-8.51 or ESP Ghostscript-7.07.1 installed.


Installed Programs: doxygen, doxytag, and optionally, doxywizard
Installed Libraries: None
Installed Directory: /usr/share/doc/doxygen

Short Descriptions


is a command-line based utility used to generate template configuration files and then generate documentation from these templates. Use doxygen --help for an explanation of the command-line parameters.


is used to generate a tag file and/or a search index for a set of HTML files.


is a GUI front-end for configuring and running doxygen.

Last updated on 2005-08-01 13:29:19 -0600