summaryrefslogtreecommitdiffstats
path: root/doc/index.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2013-01-20 13:31:30 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2013-01-20 13:31:30 (GMT)
commitdcd4714c4413348d02eb7224dafee5d06be43dfb (patch)
tree3872f0367bbee22883a702d1d2f799c9a9c2e8ac /doc/index.doc
parent775ab3be95c02dd805aadc73ffbe3c18877c12a4 (diff)
downloadDoxygen-dcd4714c4413348d02eb7224dafee5d06be43dfb.zip
Doxygen-dcd4714c4413348d02eb7224dafee5d06be43dfb.tar.gz
Doxygen-dcd4714c4413348d02eb7224dafee5d06be43dfb.tar.bz2
Release-1.8.3.1
Diffstat (limited to 'doc/index.doc')
-rw-r--r--doc/index.doc46
1 files changed, 17 insertions, 29 deletions
diff --git a/doc/index.doc b/doc/index.doc
index 3b2947d..03c6456 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -2,7 +2,7 @@
*
*
*
- * Copyright (C) 1997-2012 by Dimitri van Heesch.
+ * Copyright (C) 1997-2013 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
@@ -14,7 +14,9 @@
* input used in their production; they are not affected by this license.
*
*/
-/*! \mainpage Doxygen Manual
+/*!
+\mainpage
+<!--Doxygen Manual-->
\if logo_on
<center>
\htmlonly
@@ -25,10 +27,12 @@ Version: $(VERSION)
\endif
<h2>Introduction</h2>
-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.
+Doxygen is the de facto standard tool for generating documentation from
+annotated C++ sources, but it also supports other popular programming
+languages such as C, Objective-C, C#, PHP, Java, Python, IDL
+(Corba and Microsoft flavors), Fortran, VHDL, Tcl, and to some extent D.
-It can help you in three ways:
+Doxygen can help you in three ways:
<ol>
<li> 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
@@ -41,20 +45,19 @@ It can help you in three ways:
<li> 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
+ Doxygen 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.
<li> You can also use doxygen for creating normal documentation (as I did
- for this manual).
+ for the doxygen user manual and web-site).
</ol>
-Doxygen is developed under <a href="http://www.linux.org">Linux</a>
-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.
+Doxygen is developed under Mac OS X and Linux, 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.
+\n
+This manual is divided into three parts, each of which is divided into several sections.
The first part forms a user manual:
<ul>
@@ -115,7 +118,7 @@ The third part provides information for developers:
\addindex license
\addindex GPL
-Copyright &copy; 1997-2012 by
+Copyright &copy; 1997-2013 by
<a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.<p>
Permission to use, copy, modify, and distribute this software and its
@@ -153,21 +156,6 @@ list of projects that use doxygen (see {\tt http://www.doxygen.org/projects.html
If you know other projects, let <a href="mailto:dimitri@stack.nl?subject=New%20project%20using%20Doxygen">me</a>
know and I'll add them.
-<h2>Commercial Support</h2>
-
-I'm currently investigating the possibilities of providing
-commercial support for doxygen. The forms of support I'm thinking of
-are:
-<ul>
-<li>implementing features,
-<li>fixing bugs,
-<li>providing priority help in answering questions.
-</ul>
-To get a better understanding of the feasibility,
-please let <a href="mailto:dimitri@stack.nl?subject=Doxygen%20Commercial%20Support">me</a> know if you
-have a need for this type (or another type)
-of doxygen related commercial support.
-
<h2>Future work</h2>
Although doxygen is successfully used by large number of companies and
open source projects already, there is always room for improvement.