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.6 platform.
Download (HTTP): http://ftp.stack.nl/pub/doxygen/doxygen-1.8.8.src.tar.gz
Download (FTP): ftp://ftp.stack.nl/pub/doxygen/doxygen-1.8.8.src.tar.gz
Download MD5 sum: 0cbe6912fcac302a984bfcfb9231fec9
Download size: 4.8 MB
Estimated disk space required: 111 MB
Estimated build time: 1.3 SBU
Graphviz-2.38.0, ghostscript-9.14, Python-2.7.8, Qt-4.8.6 (for doxywizard) and texlive-20140525
User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/doxygen
Install Doxygen by running the following commands:
./configure --prefix /usr \
--docdir /usr/share/doc/doxygen-1.8.8 &&
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
--with-doxywizard: Use this parameter
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.
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.8 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.14 installed.
Last updated on 2014-09-17 21:56:07 -0700