Difference between revisions of "Doxygen"

From CBLFS
Jump to navigationJump to search
(I added the "Contents" section.)
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-{{Doxygen-Version}}.src.tar.gz
 
| ftp://ftp.stack.nl/pub/users/dimitri/doxygen-{{Doxygen-Version}}.src.tar.gz
Line 9: Line 9:
 
== Introduction to Doxygen ==
 
== 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.  
+
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.
  
−
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.
+
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. When used 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 ==
Line 21: Line 21:
 
* [[Ghostscript]]
 
* [[Ghostscript]]
 
* [[Graphviz]]
 
* [[Graphviz]]
 +
 +
== Additional Configuration Options ==
 +
 +
''--with-doxywizard'': If Qt is installed, you can use this flag to cause Doxygen's GUI front-end to be built.
  
 
== Non-Multilib ==
 
== Non-Multilib ==
Line 37: Line 41:
  
 
  make install_docs
 
  make install_docs
 +
 +
=== Command Explanations ===
 +
 +
''rm src/''unistd.h: Flex-2.5.33 has a bug that causes make to use this file instead of the system installed version. Removing this file allows the GUI front-end to build successfully. This command is not required if you don't pass the ''--with-doxywizard parameter'' (but won't affect the build otherwise).
  
 
== Multilib ==
 
== Multilib ==
Line 88: Line 96:
  
 
  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'''.
 +
|}

Revision as of 16:59, 17 December 2006

Download Source: ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.3.src.tar.gz

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. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in LATEX) 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 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. When used 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

Additional Configuration Options

--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 causes make to use this file instead of the system installed version. Removing this file allows the GUI front-end to build successfully. This command is not required if you don't pass the --with-doxywizard parameter (but won't affect the build otherwise).

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.
Retrieved from "?title=Doxygen&oldid=5611"