Release-1.3.7-20040718

14 files changed, 166 insertions, 44 deletions

diff --git a/doc/.cvsignore b/doc/.cvsignore
new file mode 100644
index 0000000..f3c7a7c
--- /dev/null
+++ b/doc/.cvsignore
@@ -0,0 +1 @@
+Makefile
diff --git a/doc/commands.doc b/doc/commands.doc
index 652f2ce..4ca0aa6 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -108,11 +108,18 @@ documentation:
 \refitem cmdpackage \\package
 \refitem cmdpage \\page
 \refitem cmdpar \\par
+\refitem cmdparagraph \\paragraph
 \refitem cmdparam \\param
 \refitem cmdpost \\post
 \refitem cmdpre \\pre
+\refitem cmd_php_only \\private (PHP only)
+\refitem cmd_php_only \\privatesection (PHP only)
 \refitem cmdproperty \\property
+\refitem cmd_php_only \\protected (PHP only)
+\refitem cmd_php_only \\protectedsection (PHP only)
 \refitem cmdprotocol \\protocol
+\refitem cmd_php_only \\public (PHP only)
+\refitem cmd_php_only \\publicsection (PHP only)
 \refitem cmdref \\ref
 \refitem cmdrelates \\relates
 \refitem cmdrelatesalso \\relatesalso
@@ -2010,10 +2017,21 @@ class C {};
   prevent auto-linking to word that is also a documented class or struct. 
 
 <hr>
-<hr>
+\section cmd_php_only PHP only commands
+For PHP files there are a number of additional commands, that can be
+used inside classes to make members public, private, or protected even
+though the language itself doesn't support this notion.
+
+To mark a single item use one of \\private, \\protected, \\public.
+For starting a section with a certain protection level use one of:
+\\privatesection, \\protectedsection, \\publicsection.
+The latter commands are similar to 
+"private:", "protected:", and "public:" in C++.
+
 <h2>\htmlonly <center> --- \endhtmlonly 
     Commands included for Qt compatibility
     \htmlonly --- </center>\endhtmlonly</h2>
+<hr>
 
 The following commands are supported to remain compatible to the Qt class
 browser generator. Do \e not use these commands in your own documentation.
@@ -2028,16 +2046,7 @@ browser generator. Do \e not use these commands in your own documentation.
 <li>\\l
 <li>\\postheader
 </ul>
-
-For PHP files there are a number of additional commands, that can be
-used inside classes to make members public, private, or protected even
-though the language itself doesn't support this notion.
-
-To mark a single item use one of \\private, \\protected, \\public.
-For starting a section with a certain protection level use one of:
-\\privatesection, \\protectedsection, \\publicsection.
-The latter commands are similar to 
-"private:", "protected:", and "public:" in C++.
+<hr>
 
 */
 
diff --git a/doc/config.doc b/doc/config.doc
index 437a56e..c37644c 100644
--- a/doc/config.doc
+++ b/doc/config.doc
@@ -97,6 +97,7 @@ followed by the descriptions of the tags grouped by category.
 \refitem cfg_extract_private EXTRACT_PRIVATE
 \refitem cfg_extract_static EXTRACT_STATIC
 \refitem cfg_file_patterns FILE_PATTERNS
+\refitem cfg_filter_patterns FILTER_PATTERNS
 \refitem cfg_filter_source_files FILTER_SOURCE_FILES
 \refitem cfg_full_path_names FULL_PATH_NAMES
 \refitem cfg_generate_autogen_def GENERATE_AUTOGEN_DEF
@@ -777,6 +778,16 @@ function's detailed documentation block.
  input file. Doxygen will then use the output that the filter program writes
  to standard output.
 
+\anchor cfg_filter_patterns
+<dt>\c FILTER_PATTERNS <dd>
+ \addindex FILTER_PATTERNS
+ The \c FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+ basis.  Doxygen will compare the file name with each pattern and apply the
+ filter if there is a match.  The filters are a list of the form:
+ pattern=filter (like <code>*.cpp=my_cpp_filter</code>). See \c INPUT_FILTER for further
+ info on how filters are used. If \c FILTER_PATTERNS is empty, \c INPUT_FILTER
+ is applied to all files. 
+
 \anchor cfg_filter_source_files
 <dt>\c FILTER_SOURCE_FILES <dd>
  \addindex FILTER_SOURCE_FILES
diff --git a/doc/doxywizard_expert.png b/doc/doxywizard_expert.png
new file mode 100644
index 0000000..93fd4ee
--- /dev/null
+++ b/doc/doxywizard_expert.png
diff --git a/doc/doxywizard_main.png b/doc/doxywizard_main.png
new file mode 100644
index 0000000..e57c144
--- /dev/null
+++ b/doc/doxywizard_main.png
diff --git a/doc/doxywizard_menu.png b/doc/doxywizard_menu.png
new file mode 100644
index 0000000..37adc46
--- /dev/null
+++ b/doc/doxywizard_menu.png
diff --git a/doc/doxywizard_page1.png b/doc/doxywizard_page1.png
new file mode 100644
index 0000000..ee3181d
--- /dev/null
+++ b/doc/doxywizard_page1.png
diff --git a/doc/doxywizard_page2.png b/doc/doxywizard_page2.png
new file mode 100644
index 0000000..dc9b5a8
--- /dev/null
+++ b/doc/doxywizard_page2.png
diff --git a/doc/doxywizard_page3.png b/doc/doxywizard_page3.png
new file mode 100644
index 0000000..f75e63f
--- /dev/null
+++ b/doc/doxywizard_page3.png
diff --git a/doc/doxywizard_page4.png b/doc/doxywizard_page4.png
new file mode 100644
index 0000000..e4f4361
--- /dev/null
+++ b/doc/doxywizard_page4.png
diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc
index 468f3fa..a758b4c 100644
--- a/doc/doxywizard_usage.doc
+++ b/doc/doxywizard_usage.doc
@@ -16,13 +16,77 @@
  */
 /*! \page doxywizard_usage Doxywizard usage
 
-Doxywizard is a GUI front-end for creating and editing 
-configuration files that are used by doxygen. 
+Doxywizard is a GUI front-end for configuring and running doxygen. 
 
-Doxywizard consists of a single executable that, when started, 
-pops up a window. 
+When you start doxywizard it will display the main window 
+(the actual look depends on the OS used).
 
-The main window has a number of tab field, one
+\image html doxywizard_main.png "Main window"
+
+The windows shows the steps to take to configure and run doxygen.
+The first step is to choose one of the ways to configure doxygen.
+<dl>
+<dt>Wizard<dd>Click this button to quickly configure the most important 
+    settings and leave the rest of the options to their defaults.
+<dt>Expert<dd>Click this button to to gain access to the 
+    \ref config "full range of configuration options".
+<dt>Load<dd>Click this button to load an existing configuration file 
+    from disk.
+</dl>
+Note that you can select multiple buttons in a row, for instance to first 
+configure doxygen using the Wizard and then fine tune the settings via 
+the Expert.
+
+After doxygen is configured you need to save the configuration as a file
+to disk. This second step allows doxygen to use the configuration 
+and has the additional advantage that the configuration can be reused 
+to run doxygen with the same settings at a later point in time.
+
+Since some configuration options may use relative paths, the next step is
+to select a directory from which to run doxygen. This is typically the root
+of the source tree and will most of the time already be filled in correctly.
+
+Once the configuration file is saved and the working directory is set, you
+can run doxygen based on the selected settings. Do this by pressing the
+"Start" button. Once doxygen runs you can cancel it by clicking the same
+button again. The output produced by doxygen is captured and shown in a log
+window. Once doxygen finishes, the log can be saved as a text file.
+
+<h3>The Wizard Dialog</h3>
+
+If you select the Wizard button in step 1, then a dialog with
+a number of tabs will appear.
+
+\image html doxywizard_page1.png "Wizard dialog: Project settings"
+
+The fields in the project tab speak for themselves. Once doxygen has finished
+the Destination directory is where to look for the results. Doxygen will
+put each output format in a separate sub-directory.
+
+\image html doxywizard_page2.png "Wizard dialog: Mode of operating"
+
+The mode tab allows you to select how doxygen will look at your sources.
+The default is to only look for things that have been documented. 
+
+You can also select how doxygen should present the results. 
+The latter does not affect the way doxygen parses your source code.
+
+\image html doxywizard_page3.png "Wizard dialog: Output to produce"
+
+You can select one or more of the output formats that doxygen should
+produce. For HTML and LaTeX there are additional options. 
+
+\image html doxywizard_page4.png "Wizard dialog: Diagrams to generate"
+
+Doxygen can produce a number of diagrams. Using the diagrams tab you
+can select which ones to generate. For most diagrams the 
+dot tool of the <a href="http://www.graphviz.org">GraphViz</a> package
+is needed (if you use the binary packages for Mac or Windows this
+tool is already included).
+
+<h3>Expert dialog</h3>
+
+The Expert dialog has a number of tab fields, one
 for each section in the configuration file. Each tab-field
 contains a number of lines, one for each configuration option in
 that section. 
@@ -38,13 +102,37 @@ The kind of input widget depends on the type of the configuration option.
 <li>For options taking a lists of strings, a one line edit field is 
     available, with a `+' button to add this string to the list and 
     a `-' button to remove the selected string from the list. There 
-    is also a button with a circular "refresh" arrow that, when pressed, 
+    is also a `*' button that, when pressed, 
     replaces the selected item in the list with the string entered in the 
     edit field. 
 <li>For file and folder entries, there are special buttons 
-    that start a file dialog.
+    that start a file selection dialog.
 </ul>
 
-\image html doxywizard.gif
+\image html doxywizard_expert.png "Some options from the Expert dialog"
+
+The get additional information about the meaning of an option, click
+on the "Help" button at the bottom right of the dialog and then on the
+item. A tooltip with additional information will appear.
+
+<h3>Menu options</h3>
+
+The GUI front-end has a menu with a couple of useful items
+
+\image html doxywizard_menu.png "File menu"
+
+<dl>
+<dt>Open...<dd>This is the same as the "Load" button in the main window
+    and allows to open a configuration file from disk.
+<dt>Save as..<dd>This is the same as the "Save" button in the main window
+    and can be used to save the current configuration settings to disk.
+<dt>Recent configurations<dd>Allow to quickly load a recently saved
+    configuration.
+<dt>Set as default...<dd>Stores the current configuration settings as the
+    default to use next time the GUI is started. You will be asked to
+    confirm the action.
+<dt>Reset...<dd>Restores the factory defaults as the default settings to use.
+    You will be asked to confirm the action.
+</dl>
 
 */
diff --git a/doc/language.doc b/doc/language.doc
index 6f4df69..dc2193f 100644
--- a/doc/language.doc
+++ b/doc/language.doc
@@ -23,12 +23,13 @@ text fragments, generated by doxygen, can be produced in languages other
 than English (the default). The output language is chosen through the
 configuration file (with default name and known as Doxyfile).
 
-Currently (version 1.3.7), 29 languages 
+Currently (version 1.3.8), 30 languages 
 are supported (sorted alphabetically):
-Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian,
-Czech, Danish, Dutch, English, Finnish, French, German, Greek,
-Hungarian, Italian, Japanese (+En), Korean (+En), Lithuanian,
-Norwegian, Polish, Portuguese, Romanian, Russian, Serbian, Slovak,.
+Afrikaans, Brazilian Portuguese, Catalan, Chinese, Chinese
+Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French,
+German, Greek, Hungarian, Italian, Japanese (+En), Korean (+En),
+Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, Serbian,
+Slovak, Slovene, Spanish, Swedish, and Ukrainian..
 
 The table of information related to the supported languages follows.
 It is sorted by language alphabetically.  The <b>Status</b> column
@@ -50,10 +51,16 @@ when the translator was updated.
   <!-- table content begin -->
 
   <tr bgcolor="#ffffff">
+    <td>Afrikaans</td>
+    <td>Johan Prinsloo</td>
+    <td>johan@NOSPAM.zippysnoek.com</td>
+    <td>up-to-date</td>
+  </tr>
+  <tr bgcolor="#ffffff">
     <td>Brazilian Portuguese</td>
     <td>Fabio "FJTC" Jun Takada Chino</td>
     <td>chino@NOSPAM.icmc.sc.usp.br</td>
-    <td>1.3.8</td>
+    <td>up-to-date</td>
   </tr>
   <tr bgcolor="#ffffff">
     <td>Catalan</td>
@@ -63,9 +70,9 @@ when the translator was updated.
   </tr>
   <tr bgcolor="#ffffff">
     <td>Chinese</td>
-    <td>Wei Liu<br>Wang Weihan</td>
-    <td>liuwei@NOSPAM.asiainfo.com<br>wangweihan@NOSPAM.capinfo.com.cn</td>
-    <td>1.2.13</td>
+    <td>Li Daobing<br>Wei Liu</td>
+    <td>lidaobing@NOSPAM.gmail.com<br>liuwei@NOSPAM.asiainfo.com</td>
+    <td>1.3.08</td>
   </tr>
   <tr bgcolor="#ffffff">
     <td>Chinese Traditional</td>
@@ -77,13 +84,13 @@ when the translator was updated.
     <td>Croatian</td>
     <td>Boris Bralo</td>
     <td>boris.bralo@NOSPAM.zg.tel.hr</td>
-    <td>1.3.8</td>
+    <td>up-to-date</td>
   </tr>
   <tr bgcolor="#ffffff">
     <td>Czech</td>
     <td>Petr P&#x0159;ikryl</td>
     <td>prikrylp@NOSPAM.skil.cz</td>
-    <td>1.3.8</td>
+    <td>up-to-date</td>
   </tr>
   <tr bgcolor="#ffffff">
     <td>Danish</td>
@@ -95,7 +102,7 @@ when the translator was updated.
     <td>Dutch</td>
     <td>Dimitri van Heesch</td>
     <td>dimitri@NOSPAM.stack.nl</td>
-    <td>1.3.8</td>
+    <td>up-to-date</td>
   </tr>
   <tr bgcolor="#ffffff">
     <td>English</td>
@@ -137,7 +144,7 @@ when the translator was updated.
     <td>Italian</td>
     <td>Alessandro Falappa<br>Ahmed Aldo Faisal</td>
     <td>alessandro@NOSPAM.falappa.net<br>aaf23@NOSPAM.cam.ac.uk</td>
-    <td>1.3.8</td>
+    <td>up-to-date</td>
   </tr>
   <tr bgcolor="#ffffff">
     <td>Japanese</td>
@@ -221,7 +228,7 @@ when the translator was updated.
     <td>Spanish</td>
     <td>Francisco Oltra Thennet</td>
     <td>foltra@NOSPAM.puc.cl</td>
-    <td>1.3.08</td>
+    <td>1.3.8</td>
   </tr>
   <tr bgcolor="#ffffff">
     <td>Swedish</td>
@@ -250,23 +257,25 @@ when the translator was updated.
   \hline
 
   \hline
-  Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny chino@icmc.sc.usp.br} & 1.3.8 \\
+  Afrikaans & Johan Prinsloo & {\tt\tiny johan@zippysnoek.com} & up-to-date \\
+  \hline
+  Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny chino@icmc.sc.usp.br} & up-to-date \\
   \hline
   Catalan & Albert Mora & {\tt\tiny amora@iua.upf.es} & 1.2.17 \\
   \hline
-  Chinese & Wei Liu & {\tt\tiny liuwei@asiainfo.com} & 1.2.13 \\
-  ~ & Wang Weihan & {\tt\tiny wangweihan@capinfo.com.cn} & ~ \\
+  Chinese & Li Daobing & {\tt\tiny lidaobing@gmail.com} & 1.3.08 \\
+  ~ & Wei Liu & {\tt\tiny liuwei@asiainfo.com} & ~ \\
   \hline
   Chinese Traditional & Daniel YC Lin & {\tt\tiny daniel@twpda.com} & 1.3.8 \\
   ~ & Gary Lee & {\tt\tiny garylee@ecosine.com.tw} & ~ \\
   \hline
-  Croatian & Boris Bralo & {\tt\tiny boris.bralo@zg.tel.hr} & 1.3.8 \\
+  Croatian & Boris Bralo & {\tt\tiny boris.bralo@zg.tel.hr} & up-to-date \\
   \hline
-  Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp@skil.cz} & 1.3.8 \\
+  Czech & Petr P\v{r}ikryl & {\tt\tiny prikrylp@skil.cz} & up-to-date \\
   \hline
   Danish & Erik S\o{}e S\o{}rensen & {\tt\tiny erik@mail.nu} & 1.3.8 \\
   \hline
-  Dutch & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & 1.3.8 \\
+  Dutch & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\
   \hline
   English & Dimitri van Heesch & {\tt\tiny dimitri@stack.nl} & up-to-date \\
   \hline
@@ -281,7 +290,7 @@ when the translator was updated.
   Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt\tiny foldvari@diatronltd.com} & 1.3.8 \\
   ~ & \'{A}kos Kiss & {\tt\tiny akiss@users.sourceforge.net} & ~ \\
   \hline
-  Italian & Alessandro Falappa & {\tt\tiny alessandro@falappa.net} & 1.3.8 \\
+  Italian & Alessandro Falappa & {\tt\tiny alessandro@falappa.net} & up-to-date \\
   ~ & Ahmed Aldo Faisal & {\tt\tiny aaf23@cam.ac.uk} & ~ \\
   \hline
   Japanese & Ryunosuke Satoh & {\tt\tiny sun594@hotmail.com} & 1.3.3 \\
@@ -314,7 +323,7 @@ when the translator was updated.
   \hline
   Slovene & Matjaz Ostroversnik & {\tt\tiny matjaz.ostroversnik@zrs-tk.si} & 1.2.16 \\
   \hline
-  Spanish & Francisco Oltra Thennet & {\tt\tiny foltra@puc.cl} & 1.3.08 \\
+  Spanish & Francisco Oltra Thennet & {\tt\tiny foltra@puc.cl} & 1.3.8 \\
   \hline
   Swedish & Mikael Hallin & {\tt\tiny mikaelhallin@yahoo.se} & 1.3.3 \\
   \hline
diff --git a/doc/maintainers.txt b/doc/maintainers.txt
index 9d19367..2022a32 100644
--- a/doc/maintainers.txt
+++ b/doc/maintainers.txt
@@ -9,6 +9,9 @@
 % the maintainer(s) for the language (one line, one maintainer)
 % in the form: <readable name><colon><e-mail>
 
+TranslatorAfrikaans
+Johan Prinsloo: johan@zippysnoek.com
+
 TranslatorBrazilian
 Fabio "FJTC" Jun Takada Chino: chino@icmc.sc.usp.br
 
@@ -16,8 +19,8 @@ TranslatorCatalan
 Albert Mora: amora@iua.upf.es
 
 TranslatorChinese
+Li Daobing: lidaobing@gmail.com
 Wei Liu: liuwei@asiainfo.com
-Wang Weihan: wangweihan@capinfo.com.cn
 
 TranslatorChinesetraditional
 Daniel YC Lin: daniel@twpda.com
diff --git a/doc/translator.py b/doc/translator.py
index c3527a8..b2da2a6 100644
--- a/doc/translator.py
+++ b/doc/translator.py
@@ -42,6 +42,7 @@
   2004/04/16 - Added new tokens to the tokenizer (to remove some warnings).
   2004/05/25 - Added from __future__ import generators not to force Python 2.3.
   2004/06/03 - Removed dependency on textwrap module.
+  2004/07/07 - Fixed the bug in the fill() function.
   """                               
 
 from __future__ import generators
@@ -70,7 +71,7 @@ def fill(s):
             else:
                 lines.append(line)  # another full line formed
                 line = word         # next line started
-        
+        lines.append(line)          # the last line
     return '\n'.join(lines)
 
     
@@ -1390,7 +1391,7 @@ class TrManager:
                 alphabetically). This means that they derive from the
                 Translator class and they implement all %d of the required
                 methods. Anyway, there still may be some details listed even 
-                for them. Please, see the details for them:'''
+                for them:'''
             s = s % len(self.requiredMethodsDic)    
             f.write('-' * 70 + '\n')
             f.write(fill(s) + '\n\n')