Release-1.4.3-20050615

6 files changed, 109 insertions, 12 deletions

diff --git a/doc/Doxyfile b/doc/Doxyfile
index 8c0cedb..ee3eb96 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -36,7 +36,7 @@ INPUT             = index.doc install.doc starting.doc docblocks.doc lists.doc \
                     autolink.doc output.doc external.doc faq.doc trouble.doc history.doc features.doc \
 		    doxygen_usage.doc doxytag_usage.doc \
                     doxywizard_usage.doc installdox_usage.doc \
-		    config.doc commands.doc htmlcmds.doc language.doc \
+		    config.doc commands.doc htmlcmds.doc xmlcmds.doc language.doc \
                     perlmod.doc perlmod_tree.doc arch.doc 
 FILE_PATTERNS     = *.cpp *.h *.doc
 EXAMPLE_PATH      = ../examples
diff --git a/doc/doxygen.1 b/doc/doxygen.1
index 3736aaa..fc4ccd8 100644
--- a/doc/doxygen.1
+++ b/doc/doxygen.1
@@ -1,9 +1,9 @@
 .TH DOXYGEN "1" "DATE" "doxygen VERSION" "User Commands"
 .SH NAME
-doxygen \- manual page for doxygen VERSION
+doxygen \- documentation system for various programming languages
 .SH DESCRIPTION
-Doxygen version VERSION
-Copyright Dimitri van Heesch 1997-2005
+Doxygen is a documentation system for C++, C, Java, Objective-C, IDL
+(Corba and Microsoft flavors) and to some extent PHP, C#, and D.
 .PP
 You can use doxygen in a number of ways:
 .TP
@@ -40,5 +40,7 @@ doxygen \fB\-e\fR rtf extensionsFile
 .PP
 If \fB\-s\fR is specified the comments in the config file will be omitted.
 If configName is omitted `Doxyfile' will be used as a default.
+.SH AUTHOR
+Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2005
 .SH SEE ALSO
 doxytag(1), doxywizard(1).
diff --git a/doc/features.doc b/doc/features.doc
index 7eefca7..e3c76ad 100644
--- a/doc/features.doc
+++ b/doc/features.doc
@@ -22,11 +22,11 @@
     Plain text will do, but for more fancy or structured output HTML tags 
     and/or some of doxygen's special commands can be used.
 <li>Supports C/C++, Java, (Corba and Microsoft) Java, 
-    IDL, and to some extent C# and PHP sources.
+    IDL, C#, Objective-C and to some extent D and PHP sources.
 <li>Supports documentation of files, namespaces, classes, structs, unions, 
     templates, variables, functions, typedefs, enums and defines. 
-<li>JavaDoc (1.1), Qt-Doc, and KDOC compatible.
-<li>Automatically generates class diagrams in HTML (as clickable 
+<li>JavaDoc (1.1), Qt-Doc, and ECMA-334 (C# spec.) compatible.
+<li>Automatically generates class and collaboration diagrams in HTML (as clickable 
     image maps) and \f$\mbox{\LaTeX}\f$ (as Encapsulated PostScript images).
 <li>Uses the dot tool of the Graphviz tool kit to generate
     include dependency graphs, collaboration diagrams, and 
@@ -76,8 +76,9 @@
 <li>Can cope with large projects easily.
 </UL>
 
-Although doxygen can be used in any C or C++ project, it was specifically
-designed to be used for projects that make use of Troll Tech's 
+Although doxygen can be used in any C or C++ project, 
+initially it was specifically designed to be used for projects that make 
+use of Troll Tech's 
 <A HREF="http://www.trolltech.com/products/qt.html">Qt toolkit</A>. I have tried to make doxygen 
 `Qt-compatible'. That is: Doxygen can read the documentation contained in 
 the Qt source code and create a class browser that looks very similar to the 
diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc
index 1639a99..0c8cd3b 100644
--- a/doc/htmlcmds.doc
+++ b/doc/htmlcmds.doc
@@ -17,9 +17,10 @@
 /*! \page htmlcmds HTML Commands
 
 Here is a list of all HTML commands that may be used inside the
-documentation. Note that all attributes of a HTML tag are passed on to 
-the HTML output only (the HREF and NAME attributes for the A tag are the 
-only exception).
+documentation. Note that although these HTML tags are translated to the
+proper commands for outer formats other than HTML, all attributes 
+of a HTML tag are passed on to the HTML output only 
+(the HREF and NAME attributes for the A tag are the only exception).
 
 <ul>
 <li><tt>\<A HREF="..."\></tt> Starts a HTML hyper-link (HTML only). 
diff --git a/doc/index.doc b/doc/index.doc
index fe0cc75..6f7fa2a 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -97,6 +97,8 @@ The second part forms a reference manual:
               used within the documentation.
 <li>Section \ref htmlcmds shows an overview of the HTML commands that
               can be used within the documentation.
+<li>Section \ref xmlcmds shows an overview of the XML commands that
+              can be used within the documentation.
 </ul>
 
 The third part provides information for developers:
@@ -186,6 +188,7 @@ Thanks go to:
 <li>Tim Mensch for adding the todo command.
 <li>Christian Hammond for redesigning the web-site.
 <li>Ken Wong for providing the HTML tree view code.
+<li>Talin for adding support for C# style comments with XML markup.
 <li>Petr Prikryl for coordinating the internationalisation support.
     All language maintainers for providing translations into many languages.
 <li>Gerald Steffens of <a href="http://www.e-trend.de">E-trend</a>
diff --git a/doc/xmlcmds.doc b/doc/xmlcmds.doc
new file mode 100644
index 0000000..f6440ef
--- /dev/null
+++ b/doc/xmlcmds.doc
@@ -0,0 +1,90 @@
+/******************************************************************************
+ *
+ * 
+ *
+ * Copyright (C) 1997-2005 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 xmlcmds XML Commands
+
+Doxygen supports most of the XML commands that are typically used in C# 
+code comments. The XML tags are defined in Appendix E of the
+<a href="http://www.ecma-international.org/publications/standards/Ecma-334.htm">ECMA-334</a> 
+standard, which defines the C# language. Unfortunately, the specification is
+not very precise and a number of the examples given are of poor quality.
+
+Here is the list of tags supported by doxygen:
+
+<ul>
+<li><tt>\<c\></tt>     Identifies inline text that should be rendered as a 
+                       piece of code. Similar to using <tt>\<tt\></tt>text<tt>\</tt\></tt>.
+<li><tt>\<code\></tt>  Set one or more lines of source code or program output.
+                       Note that this command behaves like <tt>\\code ... \\endcode</tt>
+                       for C# code, but it behaves like the HTML equivalent
+                       <tt>\<code\>...\</code\></tt> for other languages.
+<li><tt>\<description\></tt> Part of a <tt>\<list\></tt> command, describes an item.
+<li><tt>\<example\></tt> Marks a block of text as an example, ignored by doxygen.
+<li><tt>\<exception cref="member"\></tt> Identifies the exception a 
+                         method can throw.
+<li><tt>\<include\></tt> Can be used to import a piece of XML from an external
+                         file. Ignored by doxygen at the moment.
+<li><tt>\<item\></tt> List item. Can only be used inside a <tt>\<list\></tt> context.
+<li><tt>\<list type="type"\></tt> Starts a list, supported types are <tt>bullet</tt>
+                         or <tt>number</tt>. A list consists of a number of <tt>\<item\></tt> tags.
+<li><tt>\<para\></tt>    Identifies a paragraph of text.
+<li><tt>\<param name="paramName"\></tt> Marks a piece of text as the documentation
+                         for parameter "paramName". Similar to 
+                         using \ref cmdparam "\\param".
+<li><tt>\<paramref name="paramName"\></tt> Refers to a parameter with name
+                         "paramName". Similar to using \ref cmda "\\a".
+<li><tt>\<permission\></tt> Identifies the security accessibility of a member.
+                         Ignored by doygen.
+<li><tt>\<remarks\></tt> Identifies the detailed description. 
+<li><tt>\<returns\></tt> Marks a piece of text as the return value of a
+                         function or method. Similar to using \ref cmdreturn "\\return".
+<li><tt>\<see cref="member"\></tt> Refers to a member. Similar to \ref cmdref "\\ref".
+<li><tt>\<seealso cref="member"\></tt> Starts a "See also" section referring
+                         to "member". Similar to using \ref cmdsa "\\sa" member.
+<li><tt>\<summary\></tt> Identifies the brief description.
+                         Similar to using \ref cmdbrief "\\brief".
+<li><tt>\<value\></tt>   Identifies a property. Ignored by doxygen.
+</ul>
+
+Here is an example of a typical piece of code using some of the above commands:
+
+\code
+/// <summary>
+/// A search engine.
+/// </summary>
+class Engine
+{
+  /// <summary>
+  /// The Search method takes a series of parameters to specify the search criterion
+  /// and returns a dataset containing the result set.
+  /// </summary>
+  /// <param name="connectionString">the connection string to connect to the
+  /// database holding the content to search</param>
+  /// <param name="maxRows">The maximum number of rows to
+  /// return in the result set</param>
+  /// <param name="searchString">The text that we are searching for</param>
+  /// <returns>A DataSet instance containing the matching rows. It contains a maximum
+  /// number of rows specified by the maxRows parameter</returns>
+  public DataSet Search(string connectionString, int maxRows, int searchString)
+  {
+    DataSet ds = new DataSet();
+    return ds;
+  }
+}
+\endcode
+
+*/
+