Difference between revisions of "Doxygen"
From CBLFS
Jump to navigationJump to search| (13 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{| style="text-align: left; background-color: AliceBlue;" | {| style="text-align: left; background-color: AliceBlue;" | ||
| − | |- | + | |-valign="top" |
!Download Source: | !Download Source: | ||
| − | | ftp://ftp.stack.nl/pub/users/dimitri/doxygen- | + | | ftp://ftp.stack.nl/pub/users/dimitri/doxygen-{{Doxygen-Version}}.src.tar.gz |
|} | |} | ||
---- | ---- | ||
| + | |||
| + | {{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.|http://www.stack.nl/~dimitri/doxygen/}} | ||
== Dependencies == | == Dependencies == | ||
| Line 13: | Line 15: | ||
* [[TeTeX]] | * [[TeTeX]] | ||
* [[Python]] | * [[Python]] | ||
| − | * [[ | + | * [[Ghostscript]] |
* [[Graphviz]] | * [[Graphviz]] | ||
| + | |||
| + | == Configuration Information == | ||
| + | |||
| + | {|style="text-align: left;" | ||
| + | |- | ||
| + | |''--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 [[Qt3]] is installed, you can use this flag to cause Doxygen's GUI front-end to be built. | ||
| + | |} | ||
| + | |||
| + | {{Note|Doxygen does not use ''DESTDIR''. Doxygen does recognize the ''INSTALL'' variable that may be used in a manner similar to ''DESTDIR''. Using the ''INSTALL'' variable, the installation commands would become '''make INSTALL<nowiki>=<DESTDIR>/usr</nowiki>''' and '''make INSTALL<nowiki>=<DESTDIR>/usr DOCDIR=<DESTDIR>/usr/share/doc/doxygen install_docs</nowiki>'''.}} | ||
== Non-Multilib == | == Non-Multilib == | ||
| Line 20: | Line 35: | ||
Compile the package: | Compile the package: | ||
| − | |||
| − | |||
./configure --prefix /usr --docdir /usr/share/doc && | ./configure --prefix /usr --docdir /usr/share/doc && | ||
make | make | ||
| Line 40: | Line 53: | ||
Compile the package: | Compile the package: | ||
| − | |||
| − | |||
./configure --prefix /usr --docdir /usr/share/doc && | ./configure --prefix /usr --docdir /usr/share/doc && | ||
make CC="gcc ${BUILD32}" CXX="g++ ${BUILD32}" | make CC="gcc ${BUILD32}" CXX="g++ ${BUILD32}" | ||
| Line 57: | Line 68: | ||
Compile the package: | Compile the package: | ||
| − | |||
| − | |||
./configure --prefix /usr --docdir /usr/share/doc && | ./configure --prefix /usr --docdir /usr/share/doc && | ||
make CC="gcc ${BUILDN32}" CXX="g++ ${BUILDN32}" | make CC="gcc ${BUILDN32}" CXX="g++ ${BUILDN32}" | ||
| Line 74: | Line 83: | ||
Compile the package: | Compile the package: | ||
| − | |||
| − | |||
./configure --prefix /usr --docdir /usr/share/doc && | ./configure --prefix /usr --docdir /usr/share/doc && | ||
make CC="gcc ${BUILD64}" CXX="g++ ${BUILD64}" | make CC="gcc ${BUILD64}" CXX="g++ ${BUILD64}" | ||
| Line 86: | Line 93: | ||
make install_docs | make install_docs | ||
| + | |||
| + | = Contents = | ||
| + | |||
| + | {| style="text-align: left;" | ||
| + | |-valign="top" | ||
| + | ! Installed Programs: | ||
| + | | doxygen, doxytag, and optionally, doxywizard | ||
| + | |-valign="top" | ||
| + | ! Installed Libraries: | ||
| + | | None | ||
| + | |-valign="top" | ||
| + | ! Installed Directories: | ||
| + | | /usr/share/doc/doxygen | ||
| + | |} | ||
| + | |||
| + | === Short Descriptions === | ||
| + | |||
| + | {| style="text-align: left;" | ||
| + | |-valign="top" | ||
| + | ! 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. | ||
| + | |-valign="top" | ||
| + | ! doxytag | ||
| + | | is used to generate a tag file and/or a search index for a set of HTML files. | ||
| + | |-valign="top" | ||
| + | ! doxywizard | ||
| + | | is a GUI front-end for configuring and running '''doxygen'''. | ||
| + | |} | ||
| + | |||
| + | [[Category:Programming]] | ||
Latest revision as of 15:41, 19 March 2009
| Download Source: | ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.3.src.tar.gz |
|---|
Contents
Introduction to Doxygen
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.
Project Homepage: http://www.stack.nl/~dimitri/doxygen/
Dependencies
Optional
Configuration Information
| --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 Qt3 is installed, you can use this flag to cause Doxygen's GUI front-end to be built. |
Note
Doxygen does not use DESTDIR. Doxygen does recognize the INSTALL variable that may be used in a manner similar to DESTDIR. Using the INSTALL variable, the installation commands would become make INSTALL=<DESTDIR>/usr and make INSTALL=<DESTDIR>/usr DOCDIR=<DESTDIR>/usr/share/doc/doxygen install_docs.
Non-Multilib
Compile the package:
./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:
./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:
./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:
./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. |
