
Version: 0.49-990522
Doxygen license
Copyright © 1997-1999 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.
All output generated by Doxygen is not covered by this license.
Introduction
Doxygen is a documentation system for C and C++. It can generate an on-line class browser (in HTML) and/or an off-line reference manual (in
) from a set of documented source files. The documentation is extracted directly from the sources. Doxygen is developed on a Linux platform, but it runs on most other UNIX flavors as well. An executable for Windows 95/NT is also available.
Doxygen can also 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.
You can even `abuse' doxygen for creating normal documentation (as I did for this manual).
This manual is divided into two parts, each of which is divided into several sections.
The first part forms a user manual:
- Section Installation discusses how to download, compile and install doxygen for your platform.
- Section Getting started tells you how to generate your first piece of documentation quickly.
- Section Troubleshooting tells you what to do when you have problems.
The second part forms a reference manual:
- Section Features presents an overview of what Doxygen can do.
- Section Doxygen History shows what has changed during the development of Doxygen and what still has to be done.
- Section Doxygen usage shows how to use the
doxygen
program. - Section Doxytag usage shows how to use the
doxytag
program. - Section Doxysearch usage shows how to use the
doxysearch
program. - Section Installdox usage shows how to use the
installdox
script that is generated by Doxygen if you use tag files. - Section Automatic link generation shows how to put links to files, classes, and members in the documentation.
- Section Configuration shows how to fine-tune doxygen, so it generates the documentation you want.
- Section Special Commands shows an overview of the special commands that can be used within the documentation.
- Section HTML Commands shows an overview of the HTML commands that can be used within the documentation.
Acknowledgements
Thanks go to:
- Malte Zöckler and Roland Wunderling, authors of Doc++. The first version of Doxygen was based on 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 even useful for GUI-less applications like doxygen :-)
- My brother Frank for rendering the logos.
- Arnt Gulbrandsen, Adam P. Jenkins, Frank van de Pol, Ulrich Quill, Karl Robillard, Frugal the Curious, Michael Figley, Eric Bos, Barry Roberts, Mark Tigges, Jan Ekholm, Andre Johansen, Martin Franken, Martin Hofmann, Ulrich Ring, Andy Guy, Ryan Mclean, Joseph Reklow, Morten Eriksen, Arthur Pope, Andreas Felber, Matthias Schwartz, Björn Bon, Volker Börchers, Baruch Even, Kor de Jong, Thomas Eschenbacher, Bert Scholten, Germar Morgenthaler, Daniel Bellen, Terry Brown, Anke Selig, David Aspinwall, Hellmar Becker, Harald Krummeck, Christoph Koegl, Martin Reinecke, Joseph Turian, Craig P Earls, Greg Sjaardema, Vlado Sironja, Jens Schmidt, Lutz Sammer, Robert Dale, Ionutz Borcoman, Markus Noga, Darren Kelly, Joerg Ott, Kostya Serebrainy, Marco Molteni, Johannes Zellner, Ole Gerden, Olaf Meeuwissen, Feiyi Wang, Robert J. Clark, Matthias Baas, Walter Mueller, and William van Dieten for suggestions, patches and bug reports.
Generated at Thu Sep 2 10:53:31 1999 by
written by Dimitri van Heesch, © 1997-1999