Release-1.5.0

7 files changed, 112 insertions, 133 deletions

diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc
index 0403edb..08a6b1a 100644
--- a/doc/htmlcmds.doc
+++ b/doc/htmlcmds.doc
@@ -36,7 +36,11 @@ of a HTML tag are passed on to the HTML output only
 <li><tt>\<CAPTION\></tt> Starts a caption. Use within a table only.
 <li><tt>\</CAPTION\></tt> Ends a caption. Use within a table only.
 <li><tt>\<CODE\></tt>  Starts a piece of text displayed in a typewriter font.
+                       Note that for C# code, this command is equivalent to 
+                       \ref cmdcode "\\code".
 <li><tt>\</CODE\></tt> End a <tt>\<CODE\></tt> section.
+                       Note that for C# code, this command is equivalent to
+                       \ref cmdendcode "\\endcode".
 <li><tt>\<DD\></tt>    Starts an item description.
 <li><tt>\<DFN\></tt>   Starts a piece of text displayed in a typewriter font.
 <li><tt>\</DFN\></tt>  Ends a <tt>\<DFN\></tt> section.
diff --git a/doc/index.doc b/doc/index.doc
index bb91d59..921624b 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -97,7 +97,7 @@ 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
+<li>Section \ref xmlcmds shows an overview of the C# style XML commands that
               can be used within the documentation.
 </ul>
 
diff --git a/doc/install.doc b/doc/install.doc
index ad32d26..67eac06 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -344,6 +344,8 @@ of doxygen (\<=1.2.17) will not work correctly with newer versions of
 graphviz (\>=1.8.8). The effect of this incompatibility is that
 generated graphs in HTML are not properly clickable. For doxygen 1.3
 it is recommended to use at least graphviz 1.8.10 or higher.
+For doxygen 1.4.7 or higher it is recommended to 
+use GraphViz 2.8 or higher to avoid font issues.
 
 <b>Red Hat 9.0 problems</b>
 
@@ -359,6 +361,39 @@ before running make.
 
 \section install_src_windows Compiling from source on Windows
 
+From version 1.5.0 onwards, build files are provided for Visual Studio 2005.
+Also the free "Express" version of Developer Studio can be used to compile doxygen.
+Alternatively, you can compile doxygen \ref install_src_unix "the Unix way" using 
+<a href="http://en.wikipedia.org/wiki/Cygwin">Cygwin</a>
+or <a href="http://www.mingw.org/">MinGW</a>.
+
+Before you can compile doxygen you need to download and install the C++ compiler of
+Visual Studio. Since Microsoft apparently wants to lure everyone into using their 
+.NET stuff, you need to
+<a href="http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/">
+do some manual steps</a> in order to setup a proper working environment for building
+native win32 applications.
+
+Once your environment is setup, you 
+can <a href="http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc">download</a> 
+the source distribution of doxygen and unpack it. 
+If you don't have a tool like WinZip, then I suggest to download 
+<a href="http://sourceforge.net/projects/unxutils/">unxutils</a>
+and untar the archive from within a command box using
+\verbatim
+  tar zxvf doxygen-version.src.tar.gz
+\endverbatim
+Inside the archive you will find a \c winbuild directory containing a \c Doxygen.sln
+file. Just open this file in Visual Studio. You can now build the Doxygen, Doxytag,
+and Doxywizard projects for Release or Debug to compile the executables. 
+
+Note that compiling Doxywizard currently requires a <a href="http://www.trolltech.com/products/qt/qt3">
+commercial license for Qt 3</a>.
+
+Also read the next section for additional tools you may need to install.
+
+<!--
+
 Currently, I have only compiled doxygen for Windows using Microsoft's 
 Visual C++ (version 6.0). For other compilers you may need to edit the 
 perl script in <code>wintools/make.pl</code> a bit. 
@@ -507,8 +542,41 @@ Compilation is now done by performing the following steps:
     documentation can be generated. 
 </ol>
 
+-->
+
 \section install_bin_windows Installing the binaries on Windows
 
+Doxygen comes as a self-installing archive, so installation is extremely simple.
+Just follow the dialogs.
+
+After installation it is recommended to also download and install GraphViz
+(version 2.8 or better is highly recommended). Doxygen can use the \c dot tool 
+of the GraphViz package to render nicer diagrams, see the 
+\ref cfg_have_dot "HAVE_DOT" option in the configuration file.
+
+If you want to produce compressed HTML files (see \ref 
+cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the config file, then 
+you need the Microsoft HTML help workshop. 
+You can download it from 
+<a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp">Microsoft</a>.
+
+In order to generate PDF output or use scientific formulas you will also need to
+install <a href="http://en.wikipedia.org/wiki/LaTeX">LaTeX</a> and 
+<a href="http://en.wikipedia.org/wiki/Ghostscript">Ghostscript</a>. 
+
+For LaTeX a number of distributions exists. Popular onces that should work with
+doxygen are <a href="http://www.miktex.org">MikTex</a> 
+and <a href="http://www.xemtex.org">XemTex</a>.
+
+Ghostscript can be <a href="http://sourceforge.net/projects/ghostscript/">downloaded</a> 
+from Sourceforge.
+
+After installing LaTeX and Ghostscript you'll need to make sure the tools
+latex.exe, pdflatex.exe, and gswin32c.exe are present in the search path of a
+command box. Follow <a href="http://www.computerhope.com/issues/ch000549.htm">these</a>
+instructions if you are unsure and run the commands from a command box to verify it works.
+
+<!--
 There is no fancy installation procedure at the moment (if anyone can
 add it in a location independent way please let me know).
 
@@ -566,21 +634,23 @@ features:
     and the collaboration graphs.
 </ul>
 
+-->
+
 \section build_tools Tools used to develop doxygen
 
-Doxygen was developed and tested under Linux using the following 
+Doxygen was developed and tested under Linux &amp; MacOSX using the following 
 open-source tools:
 <ul>
-<li>GCC version 3.3.1
-<li>GNU flex version 2.5.4
+<li>GCC version 3.3.6 (Linux) and 4.0.1 (MacOSX)
+<li>GNU flex version 2.5.33 (Linux) and 2.5.4 (MacOSX)
 <li>GNU bison version 1.75
 <li>GNU make version 3.80
 <li>Perl version 5.8.1
 <li>VIM version 6.2
-<li>Mozilla 1.0
+<li>Firefox 1.5
 <li>Troll Tech's tmake version 1.3 (included in the distribution) 
-<li>teTeX version 1.0
-<li>CVS 1.10.7
+<li>teTeX version 2.0.2
+<li>CVS 1.12.12
 </ul>
 
 \htmlonly
diff --git a/doc/language.doc b/doc/language.doc
index 7700f7c..73316d4 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -59,7 +59,7 @@ when the translator was updated.
   <tr bgcolor="#ffffff">
     <td>Arabic</td>
     <td>Moaz Reyad</td>
-    <td><moazreyad at yahoo dot com></td>
+    <td>moazreyad at yahoo dot com</td>
     <td>1.4.6</td>
   </tr>
   <tr bgcolor="#ffffff">
@@ -126,7 +126,7 @@ when the translator was updated.
     <td>French</td>
     <td>Xavier Outhier</td>
     <td>xouthier at yahoo dot fr</td>
-    <td>1.4.6</td>
+    <td>up-to-date</td>
   </tr>
   <tr bgcolor="#ffffff">
     <td>German</td>
@@ -197,7 +197,7 @@ when the translator was updated.
   <tr bgcolor="#ffffff">
     <td>Persian</td>
     <td>Ali Nadalizadeh</td>
-    <td><nadalisoft at yahoo dot com></td>
+    <td>nadalisoft at yahoo dot com</td>
     <td>1.4.6</td>
   </tr>
   <tr bgcolor="#ffffff">
@@ -239,7 +239,7 @@ when the translator was updated.
   <tr bgcolor="#ffffff">
     <td>Slovene</td>
     <td>Matja&#x017e; Ostrover&#x0161;nik</td>
-    <td>matjaz.ostroversnik at ztm dot si</td>
+    <td>matjaz.ostroversnik at ostri dot org</td>
     <td>1.4.6</td>
   </tr>
   <tr bgcolor="#ffffff">
@@ -277,7 +277,7 @@ when the translator was updated.
   \hline
   Afrikaans & Johan Prinsloo & {\tt\tiny johan@zippysnoek.com} & 1.4.6 \\
   \hline
-  Arabic & Moaz Reyad & {\tt\tiny <moazreyad@yahoo.com>} & 1.4.6 \\
+  Arabic & Moaz Reyad & {\tt\tiny moazreyad@yahoo.com} & 1.4.6 \\
   \hline
   Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny jun-chino@uol.com.br} & up-to-date \\
   \hline
@@ -302,7 +302,7 @@ when the translator was updated.
   \hline
   Finnish & Olli Korhonen & {\tt\tiny olli.korhonen lost@cyberspace} & obsolete \\
   \hline
-  French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & 1.4.6 \\
+  French & Xavier Outhier & {\tt\tiny xouthier@yahoo.fr} & up-to-date \\
   \hline
   German & Jens Seidel & {\tt\tiny jensseidel@users.sf.net} & up-to-date \\
   \hline
@@ -333,7 +333,7 @@ when the translator was updated.
   \hline
   Norwegian & Lars Erik Jordet & {\tt\tiny lejordet@gmail.com} & 1.4.6 \\
   \hline
-  Persian & Ali Nadalizadeh & {\tt\tiny <nadalisoft@yahoo.com>} & 1.4.6 \\
+  Persian & Ali Nadalizadeh & {\tt\tiny nadalisoft@yahoo.com} & 1.4.6 \\
   \hline
   Polish & Piotr Kaminski & {\tt\tiny Piotr.Kaminski@ctm.gdynia.pl} & 1.4.6 \\
   ~ & Grzegorz Kowal & {\tt\tiny g\_kowal@poczta.onet.pl} & ~ \\
@@ -348,7 +348,7 @@ when the translator was updated.
   \hline
   Slovak & Stanislav Kudl\'{a}\v{c} & {\tt\tiny skudlac@pobox.sk} & 1.2.18 \\
   \hline
-  Slovene & Matja\v{z} Ostrover\v{s}nik & {\tt\tiny matjaz.ostroversnik@ztm.si} & 1.4.6 \\
+  Slovene & Matja\v{z} Ostrover\v{s}nik & {\tt\tiny matjaz.ostroversnik@ostri.org} & 1.4.6 \\
   \hline
   Spanish & Francisco Oltra Thennet & {\tt\tiny foltra@puc.cl} & 1.4.6 \\
   \hline
diff --git a/doc/maintainers.txt b/doc/maintainers.txt
index bc6bb22..3687a02 100644
--- a/doc/maintainers.txt
+++ b/doc/maintainers.txt
@@ -13,7 +13,7 @@ TranslatorAfrikaans
 Johan Prinsloo: johan@zippysnoek.com
 
 TranslatorArabic
-Moaz Reyad: <moazreyad@yahoo.com>
+Moaz Reyad: moazreyad@yahoo.com
 
 TranslatorBrazilian
 Fabio "FJTC" Jun Takada Chino: jun-chino@uol.com.br
@@ -86,7 +86,7 @@ TranslatorNorwegian
 Lars Erik Jordet: lejordet@gmail.com
 
 TranslatorPersian
-Ali Nadalizadeh: <nadalisoft@yahoo.com>
+Ali Nadalizadeh: nadalisoft@yahoo.com
 
 TranslatorPolish 
 Piotr Kaminski: Piotr.Kaminski@ctm.gdynia.pl
@@ -108,7 +108,7 @@ TranslatorSlovak
 Stanislav Kudl&aacute;&ccaron;: skudlac@pobox.sk
 
 TranslatorSlovene
-Matja&zcaron; Ostrover&scaron;nik: matjaz.ostroversnik@ztm.si
+Matja&zcaron; Ostrover&scaron;nik: matjaz.ostroversnik@ostri.org
 
 TranslatorSpanish 
 Francisco Oltra Thennet: foltra@puc.cl
diff --git a/doc/translator.py b/doc/translator.py
index 7795cdc..96ea736 100644
--- a/doc/translator.py
+++ b/doc/translator.py
@@ -46,6 +46,8 @@
   2004/10/04 - Reporting of not called translator methods added.
   2004/10/05 - Modified to check only doxygen/src sources for the previous report.
   2005/02/28 - Slight modification to generate "mailto.txt" auxiliary file.
+  2005/08/15 - Doxygen's root directory determined primarily from DOXYGEN 
+               environment variable. When not found, then relatively to the script.
   """                               
 
 from __future__ import generators
@@ -1177,12 +1179,16 @@ class TrManager:
         this will process only translator_cz.h source.
         """
         
-        # Determine the path to the script and the absolute path to the
-        # Doxygen's root subdirectory.
+        # Determine the path to the script and its name.
         self.script = os.path.abspath(sys.argv[0]) 
         self.script_path, self.script_name = os.path.split(self.script) 
         self.script_path = os.path.abspath(self.script_path)
-        self.doxy_path = os.path.abspath(os.path.join(self.script_path, '..'))    
+        
+        # Determine the absolute path to the Doxygen's root subdirectory.
+        # If DOXYGEN environment variable is not found, the directory is
+        # determined from the path of the script.
+        doxy_default = os.path.join(self.script_path, '..')    
+        self.doxy_path = os.path.abspath(os.getenv('DOXYGEN', doxy_default))
         
         # Get the explicit arguments of the script.
         self.script_argLst = sys.argv[1:]
@@ -1369,9 +1375,8 @@ class TrManager:
         the translator methods are included in the list. The file names 
         are searched in doxygen/src directory.
         """ 
-        srcdir = os.path.join(self.doxy_path, 'src')
         files = []
-        for item in os.listdir(srcdir):
+        for item in os.listdir(self.src_path):
             # Split the bare name to get the extension.
             name, ext = os.path.splitext(item)
             ext = ext.lower()
@@ -1379,7 +1384,7 @@ class TrManager:
             # Include only .cpp and .h files (case independent) and exclude
             # the files where the checked identifiers are defined.
             if ext == '.cpp' or (ext == '.h' and name.find('translator') == -1):
-                fname = os.path.join(srcdir, item)
+                fname = os.path.join(self.src_path, item)
                 assert os.path.isfile(fname) # assumes no directory with the ext
                 files.append(fname)          # full name
         return files
@@ -1624,7 +1629,7 @@ class TrManager:
         
         Fills the dictionary classId -> [(name, e-mail), ...]."""
         
-        fname = os.path.join(self.script_path, self.maintainersFileName)
+        fname = os.path.join(self.doc_path, self.maintainersFileName)
 
         # Include the maintainers file to the group of files checked with
         # respect to the modification time.
@@ -1678,7 +1683,7 @@ class TrManager:
         # Check the last modification time of the template file. It is the
         # last file from the group that decide whether the documentation
         # should or should not be generated.
-        fTplName = os.path.join(self.script_path, self.languageTplFileName)
+        fTplName = os.path.join(self.doc_path, self.languageTplFileName)
         tim = os.path.getmtime(fTplName)
         if tim > self.lastModificationTime:
             self.lastModificationTime = tim
diff --git a/doc/translator_report.txt b/doc/translator_report.txt
index 5eace54..6d46178 100644
--- a/doc/translator_report.txt
+++ b/doc/translator_report.txt
@@ -8,7 +8,7 @@ German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean
 (+En), Lithuanian, Norwegian, Persian, Polish, Portuguese, Romanian,
 Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
 
-Of them, 12 translators are up-to-date, 21 translators are based on
+Of them, 13 translators are up-to-date, 20 translators are based on
 some adapter class, and 2 are English based.
 
 ----------------------------------------------------------------------
@@ -17,16 +17,17 @@ alphabetically). This means that they derive from the Translator class
 and they implement all 194 of the required methods. Anyway, there
 still may be some details listed even for them:
 
-  TranslatorBrazilian -- Remove the obsolete methods (never used).
+  TranslatorBrazilian
   TranslatorCatalan
   TranslatorChinese
   TranslatorCroatian
   TranslatorCzech
-  TranslatorDanish -- Change the base class to Translator.
-  TranslatorDutch -- Remove the obsolete methods (never used).
-  TranslatorEnglish -- Remove the obsolete methods (never used).
+  TranslatorDanish
+  TranslatorDutch
+  TranslatorEnglish
+  TranslatorFrench
   TranslatorGerman
-  TranslatorItalian -- Change the base class to Translator.
+  TranslatorItalian
   TranslatorJapanese -- Remove the obsolete methods (never used).
   TranslatorRussian
 
@@ -46,7 +47,6 @@ must be implemented to become up-to-date:
   TranslatorKorean                1.4.6 	 2 methods to implement
   TranslatorIndonesian            1.4.6 	 1 method to implement
   TranslatorHungarian             1.4.6 	 2 methods to implement
-  TranslatorFrench                1.4.6 	 1 method to implement
   TranslatorChinesetraditional    1.4.6 	 1 method to implement
   TranslatorArabic                1.4.6 	 1 method to implement
   TranslatorAfrikaans             1.4.6 	 2 methods to implement
@@ -105,24 +105,6 @@ TranslatorArabic   (TranslatorAdapter_1_4_6)  1 method to implement
     virtual QCString trNoDescriptionAvailable()
 
 
-TranslatorBrazilian   (Translator)
--------------------
-
-  Implements 194 of the required methods.
-
-  Obsolete methods (should be removed, never used):
-
-    virtual QCString trHeaderFilesDescription()
-    virtual QCString trField(bool first_capital, bool singular)
-    virtual QCString trPackageDocumentation()
-    virtual QCString trSources()
-    virtual QCString trReimplementedForInternalReasons()
-    virtual QCString trInterfaces()
-    virtual QCString trHeaderFiles()
-    virtual QCString trBugsAndLimitations()
-    virtual QCString trNoDescriptionAvailable()
-
-
 TranslatorChinesetraditional   (TranslatorAdapter_1_4_6)  1 method to implement
 ----------------------------
 
@@ -145,60 +127,6 @@ TranslatorChinesetraditional   (TranslatorAdapter_1_4_6)  1 method to implement
     virtual QCString trNoDescriptionAvailable()
 
 
-TranslatorDanish   (TranslatorAdapter_1_3_9)
-----------------
-
-  Implements 194 of the required methods.
-
-  Obsolete methods (should be removed, never used):
-
-    virtual QCString trHeaderFilesDescription()
-    virtual QCString trField(bool first_capital, bool singular)
-    virtual QCString trPackageDocumentation()
-    virtual QCString trSources()
-    virtual QCString trReimplementedForInternalReasons()
-    virtual QCString trInterfaces()
-    virtual QCString trHeaderFiles()
-    virtual QCString trBugsAndLimitations()
-    virtual QCString trNoDescriptionAvailable()
-
-
-TranslatorDutch   (Translator)
----------------
-
-  Implements 194 of the required methods.
-
-  Obsolete methods (should be removed, never used):
-
-    QCString trHeaderFilesDescription()
-    virtual QCString trField(bool first_capital, bool singular)
-    QCString trPackageDocumentation()
-    QCString trSources()
-    QCString trReimplementedForInternalReasons()
-    QCString trInterfaces()
-    QCString trHeaderFiles()
-    QCString trBugsAndLimitations()
-    QCString trNoDescriptionAvailable()
-
-
-TranslatorEnglish   (Translator)
------------------
-
-  Implements 194 of the required methods.
-
-  Obsolete methods (should be removed, never used):
-
-    virtual QCString trHeaderFilesDescription()
-    virtual QCString trField(bool first_capital, bool singular)
-    virtual QCString trPackageDocumentation()
-    virtual QCString trSources()
-    virtual QCString trReimplementedForInternalReasons()
-    virtual QCString trInterfaces()
-    virtual QCString trHeaderFiles()
-    virtual QCString trBugsAndLimitations()
-    virtual QCString trNoDescriptionAvailable()
-
-
 TranslatorFinnish   (TranslatorEnglish)  96 methods to implement
 -----------------
 
@@ -315,28 +243,6 @@ TranslatorFinnish   (TranslatorEnglish)  96 methods to implement
     QCString trNoDescriptionAvailable()
 
 
-TranslatorFrench   (TranslatorAdapter_1_4_6)  1 method to implement
-----------------
-
-  Implements 193 of the required methods.
-
-  Missing methods (should be implemented):
-
-    virtual QCString trCallerGraph()
-
-  Obsolete methods (should be removed, never used):
-
-    virtual QCString trHeaderFilesDescription()
-    virtual QCString trField(bool first_capital, bool singular)
-    virtual QCString trPackageDocumentation()
-    virtual QCString trSources()
-    virtual QCString trReimplementedForInternalReasons()
-    virtual QCString trInterfaces()
-    virtual QCString trHeaderFiles()
-    virtual QCString trBugsAndLimitations()
-    virtual QCString trNoDescriptionAvailable()
-
-
 TranslatorGreek   (TranslatorAdapter_1_2_11)  27 methods to implement
 ---------------
 
@@ -418,12 +324,6 @@ TranslatorIndonesian   (TranslatorAdapter_1_4_6)  1 method to implement
     virtual QCString trNoDescriptionAvailable()
 
 
-TranslatorItalian   (TranslatorAdapter_1_4_6)
------------------
-
-  Implements 194 of the required methods.
-
-
 TranslatorJapanese   (Translator)
 ------------------