/****************************************************************************** * * * * Copyright (C) 1997-2011 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its * documentation under the terms of the GNU General Public License is hereby * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * * Documents produced by Doxygen are derivative works derived from the * input used in their production; they are not affected by this license. * */ /*! \mainpage \if logo_on
\htmlonly doxygen
Version: $(VERSION) \endhtmlonly
\endif

Introduction

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D. It can help you in three ways:
  1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in \f$\mbox{\LaTeX}\f$) 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.
  2. You can \ref extract_all "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.
  3. You can even `abuse' doxygen for creating normal documentation (as I did for this manual).
Doxygen is developed under Linux and Mac OS X, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available. \n This manual is divided into three parts, each of which is divided into several sections. The first part forms a user manual: The second part forms a reference manual: The third part provides information for developers: \n

Doxygen license

\addindex license \addindex GPL Copyright © 1997-2011 by Dimitri van Heesch.

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.

User examples

Doxygen supports a number of \ref output "output formats" where HTML is the most popular one. I've gathered \htmlonly some nice examples \endhtmlonly \latexonly some nice examples (see {\tt http://www.doxygen.org/results.html}) \endlatexonly of real-life projects using doxygen. These are part of a larger \htmlonly list of projects that use doxygen. \endhtmlonly \latexonly list of projects that use doxygen (see {\tt http://www.doxygen.org/projects.html}). \endlatexonly If you know other projects, let me know and I'll add them.

Commercial Support

I'm currently investigating the possibilities of providing commercial support for doxygen. The forms of support I'm thinking of are: To get a better understanding of the feasibility, please let me know if you have a need for this type (or another type) of doxygen related commercial support.

Future work

Although doxygen is successfully used by large number of companies and open source projects already, there is always room for improvement.

You can submit enhancement requests in the bug tracker. Make sure the severity of the bug report is set to "enhancement".

Acknowledgements

\addindex acknowledgements Thanks go to: */