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

Installation of Doxygen

Install Doxygen by running the following commands:

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

Now, as the root user:

make install

If you wish to generate and install the package documentation, ensure the Python, TeX and Graphviz packages are installed, then substitute the following commands for the make install command above:

make docs &&
make pdf &&
install -d -m755 /usr/share/doc/doxygen/src &&
install -m644 src/translator{,_adapter,_en}.h \
    /usr/share/doc/doxygen/src &&
install -m644 VERSION /usr/share/doc/doxygen &&
make install_docs

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.

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

make docs: This command builds the HTML documentation.

make pdf: This command builds a PDF version of the Doxygen Manual.

install ...: These commands install some files required by the documentation installation.

Note: For documentation in a language other than English, replace the “_en” with the country code of your locale.

make install_docs: This command installs the binaries and documentation.


Installed Programs: doxygen, doxytag and doxywizard
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-02-08 19:52:39 -0700