/****************************************************************************** * * * * Copyright (C) 1997-2000 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. * */ /*! \page index
\htmlonly doxygen
Version: $(VERSION) \endhtmlonly

Doxygen license

\addindex license \addindex GPL Copyright © 1997-2000 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.

It is hereby explicitly allowed that this program may be linked against Troll Tech's Qt library, and distributed, without the GPL applying to Qt.

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

Introduction

Doxygen is a documentation system for C++, IDL (Corba and Microsoft flavors) and C. 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. Doxygen can be configured to extract the code structure from undocumented source files. This can be very useful to quickly find your way in large source distributions. The relations between the various elements are be visualized 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 on Linux, but is set-up to be highly portable. As a result, it runs on most other UNIX flavors as well. Furthermore, an executable for Windows 9x/NT is also available. This manual is divided into two parts, each of which is divided into several sections. The first part forms a user manual: The second part forms a reference manual:

Projects using doxygen

I have compiled a \htmlonly list of projects that use doxygen. \endhtmlonly \latexonly list of projects that use doxygen (see {\tt http://www.stack.nl/$\sim$dimitri/doxygen/projects.html}). \endlatexonly If you know other projects, let me know and I'll add them.

Future work

Although doxygen is used successfully by a lot of people already, there is always room for improvement. Therefore, I have compiled a \htmlonly todo/wish list \endhtmlonly \latexonly todo/wish list (see {\tt http://www.stack.nl/$\sim$dimitri/doxygen/todo.html}) \endlatexonly of possible and/or requested enhancements.

Acknowledgements

\addindex acknowledgements Thanks go to: */