Difference between revisions of "Doxygen"
(I added addtional configuration options and added a note about DESTDIR.) |
|||
| Line 7: | Line 7: | ||
---- | ---- | ||
| − | + | {{Package-Introduction|Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D. | |
| − | |||
| − | Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D. | ||
It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in '''L<sup style="position:relative;top:0.25em">A</sup>T<sub><big>E</big></sub>X''') from a set of documented source files. There is also support for generating output in RTF (MS-Word), 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. | It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in '''L<sup style="position:relative;top:0.25em">A</sup>T<sub><big>E</big></sub>X''') from a set of documented source files. There is also support for generating output in RTF (MS-Word), 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 configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. 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. | + | You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. 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.|http://www.stack.nl/~dimitri/doxygen/}} |
| − | |||
| − | |||
== Dependencies == | == Dependencies == | ||
Revision as of 12:33, 16 April 2007
| Download Source: | ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.3.src.tar.gz |
|---|
Contents
Introduction to Doxygen
http://www.stack.nl/~dimitri/doxygen/
Project Homepage: Unknown
Dependencies
Optional
Note to DESTDIR Fans
Unfortunately, this package ignores DESTDIR. However, we can pervert to our purposes the variable that it uses for prefix. The installation commands thus become:
make INSTALL=/usr<DESTDIR>
and
make INSTALL=/usr<DESTDIR> \ DOCDIR=<DESTDIR>/usr/share/doc/doxygen \ install_docs
Additional Configuration Options
--english-only: Include support for English only.
--enable-langs list: Include support for output languages listed in list. [default: nl,se,cz,fr,id,it,de,jp,je,es,fi,ru,hr,pl,pt,hu,kr,ke,ro,si,cn,no,br,dk,sk,ua,gr,tw,sr,ca,lt,za,ar,fa]
--with-doxywizard: If Qt is installed, you can use this flag to cause Doxygen's GUI front-end to be built.
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
Command Explanations
rm src/unistd.h: Flex-2.5.33 has a bug that makes it so that it uses src/unistd.h instead of the version installed on your system. To avoid this, we remove src/unistd.h. Since this fixes a problem with the building of Doxygen's GUI front-end, you don't really need to do this if you're not building the GUI front-end (by using the flag --with-doxywizard), but it doesn't hurt.
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
Contents
| Installed Programs: | doxygen, doxytag, and optionally, doxywizard |
|---|---|
| Installed Libraries: | None |
| Installed Directories: | /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. |
|---|---|
| doxytag | is used to generate a tag file and/or a search index for a set of HTML files. |
| doxywizard | is a GUI front-end for configuring and running doxygen. |
