Source code documentation generator toolDoxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extend D. It can help you in three ways:
It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) 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 even `abuse' doxygen for creating normal documentation (as I did for this manual).
Malte Zöckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen.[*]All people at Troll Tech, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer :-)[*]Kevin McBride for maintaining the subversion reporsitory for doxygen.[*]My brother Frank for rendering the logos.[*]Harm van der Heijden for adding HTML help support.[*]Wouter Slegers of Your Creative Solutions for registering the www.doxygen.org domain.[*]Parker Waechter for adding the RTF output generator.[*]Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator.[*]Matthias Andree for providing a .spec script for building rpms from the sources.[*]Tim Mensch for adding the todo command.[*]Christian Hammond for redesigning the web-site.[*]Ken Wong for providing the HTML tree view code.[*]Talin for adding support for C# style comments with XML markup.[*]Petr Prikryl for coordinating the internationalisation support. All language maintainers for providing translations into many languages.[*]The band Porcupine Tree for providing hours of great music to listen to while coding.[*]many, many others for suggestions, patches and bug reports.
DownLoad:: ->
###############Doxygen source and binary releasesLatest releaseThe latest version of doxygen is 1.5.5 (release date 10 February 2008).
The source distribution doxygen-1.5.5.src.tar.gz (3.8M) ( ftp | http )
A binary distribution for Linux i386 doxygen-1.5.5.linux.bin.tar.gz (2.5M) ( ftp | http )
Compiled using Fedora Core 6 with kernel 2.6.19 and gcc-4.1.2. This archive includes the HTML version of the manual, but not the GUI frontend.
A binary distribution for Windows 95/98/ME/NT/2000/XP/Vista doxygen-1.5.5-setup.exe (6.5M) ( ftp | http )
This is a self-installing archive including the HTML and compressed HTML versions of the manual and the GUI frontend. If you are allergic to installers and GUIs or haven't sufficient bandwidth you can also download the binaries in a zip (2.2M) ( ftp | http )
A universal binary distribution for Mac OS X Doxygen-1.5.5.dmg (17.6M) ( ftp | http )
This is a self-contained disk image, which contains the GUI frontend and dot. All binaries are universal.
See the change log to find out what has changed. If you want to be informed about new releases fill in your email address in the form at the top of this page. The documentation for release 1.5.5A hyperlinked PDF version of the documentation doxygen_manual-1.5.5.pdf.zip (0.6M)
A compiled HTML version of the documentation doxygen_manual-1.5.5.chm.zip (0.8M)
//! A test class.
/*!
A more elaborate class description.
*/
class Test
{
public:
//! An enum.
/*! More detailed enum description. */
enum TEnum {
TVal1, /*!< Enum value TVal1. */
TVal2, /*!< Enum value TVal2. */
TVal3 /*!< Enum value TVal3. */
}
//! Enum pointer.
/*! Details. */
*enumPtr,
//! Enum variable.
/*! Details. */
enumVar;
//! A constructor.
/*!
A more elaborate description of the constructor.
*/
Test();
//! A destructor.
/*!
A more elaborate description of the destructor.
*/
~Test();
//! A normal member taking two arguments and returning an integer value.
/*!
\param a an integer argument.
\param s a constant character pointer.
\return The test results
\sa Test(), ~Test(), testMeToo() and publicVar()
*/
int testMe(int a,const char *s);
//! A pure virtual member.
/*!
\sa testMe()
\param c1 the first argument.
\param c2 the second argument.
*/
virtual void testMeToo(char c1,char c2) = 0;
//! A public variable.
/*!
Details.
*/
int publicVar;
//! A function variable.
/*!
Details.
*/
int (*handler)(int a,int b);
};