summaryrefslogtreecommitdiffstats
path: root/doc/index.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>1999-12-15 19:25:10 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>1999-12-15 19:25:10 (GMT)
commit322885a8700a209812bf5a94205260c9bef6ac1f (patch)
treecc1cd70cf5761ddf72ff114c0b65576c3f4c1d2a /doc/index.doc
parent361bf7915be13b5c74688e33c427aea30641814c (diff)
downloadDoxygen-322885a8700a209812bf5a94205260c9bef6ac1f.zip
Doxygen-322885a8700a209812bf5a94205260c9bef6ac1f.tar.gz
Doxygen-322885a8700a209812bf5a94205260c9bef6ac1f.tar.bz2
initial version
Diffstat (limited to 'doc/index.doc')
-rw-r--r--doc/index.doc163
1 files changed, 163 insertions, 0 deletions
diff --git a/doc/index.doc b/doc/index.doc
new file mode 100644
index 0000000..add62b4
--- /dev/null
+++ b/doc/index.doc
@@ -0,0 +1,163 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ * Copyright (C) 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 with Doxygen is not covered by this license.
+ *
+ */
+/*! \page index
+<center>
+\htmlonly
+<img align=center lowsrc="doxygen_logo_low.gif" src="doxygen_logo.gif"
+ width=634 height=197 alt="doxygen"><br>
+Version: $(VERSION)
+\endhtmlonly
+</center>
+
+<h2>Doxygen license</h2>
+\addindex license
+\addindex GPL
+
+Copyright &copy; 1997-1999 by
+<a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.<p>
+
+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.
+<p>
+All output generated by Doxygen is not covered by this license.
+
+<h2>Introduction</h2>
+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 \f$\mbox{\LaTeX}\f$) from a set
+of documented source files. The documentation is extracted directly from the
+sources. Doxygen is developed on a <a href="http://www.linux.org">Linux</a>
+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:
+<ul>
+<li>Section \ref install discusses how to download, compile and install
+ doxygen for your platform.
+<li>Section \ref starting tells you how to generate your first piece of
+ documentation quickly.
+<li>Section \ref trouble tells you what to do when you have problems.
+</ul>
+
+The second part forms a reference manual:
+
+<ul>
+<li>Section \ref features presents an overview of what Doxygen can do.
+<li>Section \ref history shows what has changed during the development
+ of Doxygen and what still has to be done.
+<li>Section \ref doxygen_usage shows how to use the \c doxygen program.
+<li>Section \ref doxytag_usage shows how to use the \c doxytag program.
+<li>Section \ref doxysearch_usage shows how to use the \c doxysearch program.
+<li>Section \ref installdox_usage shows how to use the \c installdox
+ script that is generated by Doxygen if you use tag files.
+<li>Section \ref autolink shows how to put links to files, classes,
+ and members in the documentation.
+<li>Section \ref config shows how to fine-tune doxygen, so it
+ generates the documentation you want.
+<li>Section \ref commands shows an overview of the special commands that can be
+ used within the documentation.
+<li>Section \ref htmlcmds shows an overview of the HTML commands that
+ can be used within the documentation.
+</ul>
+
+<h2>Acknowledgements</h2>
+\addindex acknowledgements
+Thanks go to:
+<ul>
+\addindex Doc++
+<li>Malte Z&ouml;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.
+<li>All people at Troll Tech, for creating a beautiful GUI Toolkit.
+ (which is even useful for GUI-less applications like doxygen :-)
+<li>My brother <a href="http://www.stack.nl/~fidget/index.html">Frank</a>
+ for rendering the logos.
+<li>
+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&ouml;rn Bon,
+Volker B&ouml;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 and
+Walter Mueller
+ for suggestions, patches and bug reports.
+</ul>
+*/
+