%general-entities; ]> $LastChangedBy$ $Date$ 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 Download (HTTP): Download (FTP): Download MD5 sum: &doxygen-md5sum; Download size: &doxygen-size; Estimated disk space required: &doxygen-buildsize; Estimated build time: &doxygen-time; Doxygen Dependencies Optional (for doxywizard), , , , or User Notes: If you have both and installed, be sure to set the environment variable QTDIR to point to the Qt4 top level directory if you add the --with-doxywizard option. Install Doxygen by running the following commands: ./configure --prefix /usr \ --docdir /usr/share/doc && make 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 Python, teTeX (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. 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 installed. If you require formulas to create PDF documentation, then you must have installed. If you require formulas to convert PostScript files to bitmaps, then you must have or installed. Installed Programs Installed Libraries Installed Directory doxygen, doxytag, and optionally, doxywizard None /usr/share/doc/doxygen 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. doxygen doxytag is used to generate a tag file and/or a search index for a set of HTML files. doxytag doxywizard is a GUI front-end for configuring and running doxygen. doxywizard