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.
Qt-3.3.8b, Graphviz-2.12, Python-2.5.2, teTeX-3.0,
ESP Ghostscript-8.15.4 or AFPL
User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/doxygen
Installation of Doxygen
Install Doxygen by running the
./configure --prefix /usr \
--docdir /usr/share/doc &&
This package does not come with a test suite.
Now, as the
If you wish to generate and install the package documentation (note
that man pages have already been installed), you must have
Python, teTeX (for HTML docs) and Ghostscript (for PDF docs) installed, then
issue the following command as the
--with-doxywizard: Use this parameter
if Qt is installed and you wish to
build the GUI front-end.
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.5.2 installed. If you require formulas
to create PDF documentation, then you must have teTeX-3.0 installed.
If you require formulas to convert PostScript files to bitmaps,
then you must have AFPL Ghostscript-8.53 or ESP
doxygen, doxytag, and optionally,
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
Last updated on 2007-04-19 18:17:33 -0500