Beyond Linux® From Scratch - Version 2015-03-06-multilib

Chapter 13. Programming

Doxygen-1.8.9.1

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. It 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.

This package is known to build and work properly using an LFS-7.7 platform.

Package Information

Doxygen Dependencies

Optional

Graphviz-2.38.0, ghostscript-9.15, LLVM-3.5.1 (with clang), Python-2.7.9 or Python-3.4.2, Qt-4.8.6 (for doxywizard), texlive-20140525 (or install-tl-unx) and xapian-1.2.19 (for doxyindexer)

User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/doxygen

Installation of Doxygen

Install Doxygen by running the following commands: 

./configure --prefix /usr \
            --docdir /usr/share/doc/doxygen-1.8.9.1 &&
make

This package does not come with a test suite.

Now, as the root user: 

make MAN1DIR=share/man/man1 install

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

make install_docs

Command Explanations

--with-doxywizard: Use this switch if Qt4 is installed and you wish to build the GUI front-end. If both Qt4 and Qt5 are installed, use source setqt4. If Qt4 is installed in /opt, issue export QTDIR=$QT4DIR.

--with-doxysearch: Use this switch if xapian is installed and you wish to build external search tools (doxysearch.cgi and doxyindexer).

--with-libclang: Use this switch if llvm with clang are installed, to add support for libclang parsing.

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.7.9 installed. If you require formulas to create PDF documentation, then you must have texlive-20140525 installed. If you require formulas to convert PostScript files to bitmaps, then you must have ghostscript-9.15 installed.

Contents

Installed Programs: doxygen and optionally, doxywizard, doxyindexer and doxysearch.cgi
Installed Libraries: None
Installed Directory: /usr/share/doc/doxygen-1.8.9.1

Short Descriptions

doxygen

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.

doxywizard

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

doxyindexer

generates a search index called doxysearch.db from one or more search data files produced by doxygen. See, e.g. http://www.stack.nl/~dimitri/doxygen/manual/extsearch.html.

doxysearch.cgi

is a CGI program to search the data indexed by doxyindexer.

Last updated on 2015-02-23 16:51:12 -0500