Difference between revisions of "Doxygen"
(I added the package description from BLFS.) |
|||
Line 6: | Line 6: | ||
---- | ---- | ||
+ | |||
+ | == 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. | ||
== Dependencies == | == Dependencies == |
Revision as of 00:30, 4 December 2006
Download Source: | ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.5.0.src.tar.gz |
---|
Contents
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.
Dependencies
Optional
Non-Multilib
Compile the package:
rm src/unistd.h && ./configure --prefix /usr --docdir /usr/share/doc && make
Install the package
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:
make install_docs
Multilib
This package does not provide any libraries so only one installation is needed.
32Bit
Compile the package:
rm src/unistd.h && ./configure --prefix /usr --docdir /usr/share/doc && make CC="gcc ${BUILD32}" CXX="g++ ${BUILD32}"
Install the package
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:
make install_docs
N32
Compile the package:
rm src/unistd.h && ./configure --prefix /usr --docdir /usr/share/doc && make CC="gcc ${BUILDN32}" CXX="g++ ${BUILDN32}"
Install the package
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:
make install_docs
64Bit
Compile the package:
rm src/unistd.h && ./configure --prefix /usr --docdir /usr/share/doc && make CC="gcc ${BUILD64}" CXX="g++ ${BUILD64}"
Install the package
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:
make install_docs